blob: c91730defff5c7b35c8701f5541887a16ad49437 [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
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070041// All VUID from copy_bufferimage_to_imagebuffer_common.txt
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070042static const char *GetBufferImageCopyCommandVUID(std::string id, bool image_to_buffer, bool copy2) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070043 // clang-format off
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070044 static const std::map<std::string, std::array<const char *, 4>> copy_imagebuffer_vuid = {
45 {"00193", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070046 "VUID-vkCmdCopyBufferToImage-bufferOffset-00193", // !copy2 & !image_to_buffer
47 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00193", // !copy2 & image_to_buffer
48 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00193", // copy2 & !image_to_buffer
49 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00193", // copy2 & image_to_buffer
50 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070051 {"01558", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070052 "VUID-vkCmdCopyBufferToImage-bufferOffset-01558",
53 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01558",
54 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01558",
55 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01558",
56 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070057 {"01559", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070058 "VUID-vkCmdCopyBufferToImage-bufferOffset-01559",
59 "VUID-vkCmdCopyImageToBuffer-bufferOffset-01559",
60 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-01559",
61 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-01559",
62 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070063 {"00197", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070064 "VUID-vkCmdCopyBufferToImage-imageOffset-00197",
65 "VUID-vkCmdCopyImageToBuffer-imageOffset-00197",
66 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00197",
67 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00197",
68 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070069 {"00198", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070070 "VUID-vkCmdCopyBufferToImage-imageOffset-00198",
71 "VUID-vkCmdCopyImageToBuffer-imageOffset-00198",
72 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00198",
73 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00198",
74 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070075 {"00199", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070076 "VUID-vkCmdCopyBufferToImage-srcImage-00199",
77 "VUID-vkCmdCopyImageToBuffer-srcImage-00199",
78 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00199",
79 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00199",
80 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070081 {"00200", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070082 "VUID-vkCmdCopyBufferToImage-imageOffset-00200",
83 "VUID-vkCmdCopyImageToBuffer-imageOffset-00200",
84 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00200",
85 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00200",
86 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070087 {"00201", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070088 "VUID-vkCmdCopyBufferToImage-srcImage-00201",
89 "VUID-vkCmdCopyImageToBuffer-srcImage-00201",
90 "VUID-VkCopyBufferToImageInfo2KHR-srcImage-00201",
91 "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00201",
92 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070093 {"00203", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -070094 "VUID-vkCmdCopyBufferToImage-bufferRowLength-00203",
95 "VUID-vkCmdCopyImageToBuffer-bufferRowLength-00203",
96 "VUID-VkCopyBufferToImageInfo2KHR-bufferRowLength-00203",
97 "VUID-VkCopyImageToBufferInfo2KHR-bufferRowLength-00203",
98 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -070099 {"00204", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700100 "VUID-vkCmdCopyBufferToImage-bufferImageHeight-00204",
101 "VUID-vkCmdCopyImageToBuffer-bufferImageHeight-00204",
102 "VUID-VkCopyBufferToImageInfo2KHR-bufferImageHeight-00204",
103 "VUID-VkCopyImageToBufferInfo2KHR-bufferImageHeight-00204",
104 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700105 {"00205", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700106 "VUID-vkCmdCopyBufferToImage-imageOffset-00205",
107 "VUID-vkCmdCopyImageToBuffer-imageOffset-00205",
108 "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-00205",
109 "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-00205",
110 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700111 {"00206", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700112 "VUID-vkCmdCopyBufferToImage-bufferOffset-00206",
113 "VUID-vkCmdCopyImageToBuffer-bufferOffset-00206",
114 "VUID-VkCopyBufferToImageInfo2KHR-bufferOffset-00206",
115 "VUID-VkCopyImageToBufferInfo2KHR-bufferOffset-00206",
116 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700117 {"00207", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700118 "VUID-vkCmdCopyBufferToImage-imageExtent-00207",
119 "VUID-vkCmdCopyImageToBuffer-imageExtent-00207",
120 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00207",
121 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00207",
122 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700123 {"00208", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700124 "VUID-vkCmdCopyBufferToImage-imageExtent-00208",
125 "VUID-vkCmdCopyImageToBuffer-imageExtent-00208",
126 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00208",
127 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00208",
128 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700129 {"00209", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700130 "VUID-vkCmdCopyBufferToImage-imageExtent-00209",
131 "VUID-vkCmdCopyImageToBuffer-imageExtent-00209",
132 "VUID-VkCopyBufferToImageInfo2KHR-imageExtent-00209",
133 "VUID-VkCopyImageToBufferInfo2KHR-imageExtent-00209",
134 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700135 {"00211", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700136 "VUID-vkCmdCopyBufferToImage-aspectMask-00211",
137 "VUID-vkCmdCopyImageToBuffer-aspectMask-00211",
138 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-00211",
139 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-00211",
140 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700141 {"01560", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700142 "VUID-vkCmdCopyBufferToImage-aspectMask-01560",
143 "VUID-vkCmdCopyImageToBuffer-aspectMask-01560",
144 "VUID-VkCopyBufferToImageInfo2KHR-aspectMask-01560",
145 "VUID-VkCopyImageToBufferInfo2KHR-aspectMask-01560",
146 }},
sfricke-samsung2e5b16c2020-10-31 22:14:15 -0700147 {"00213", {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -0700148 "VUID-vkCmdCopyBufferToImage-baseArrayLayer-00213",
149 "VUID-vkCmdCopyImageToBuffer-baseArrayLayer-00213",
150 "VUID-VkCopyBufferToImageInfo2KHR-baseArrayLayer-00213",
151 "VUID-VkCopyImageToBufferInfo2KHR-baseArrayLayer-00213",
152 }}
153 };
154 // clang-format on
155
156 uint8_t index = 0;
157 index |= (image_to_buffer) ? 0x1 : 0;
158 index |= (copy2) ? 0x2 : 0;
159 return copy_imagebuffer_vuid.at(id).at(index);
160}
161
John Zulauff660ad62019-03-23 07:16:05 -0600162// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
163static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
164 VkImageSubresourceRange subresource_range;
165 subresource_range.aspectMask = subresource_layers.aspectMask;
166 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
167 subresource_range.layerCount = subresource_layers.layerCount;
168 subresource_range.baseMipLevel = subresource_layers.mipLevel;
169 subresource_range.levelCount = 1;
170 return subresource_range;
171}
172
John Zulaufb58415b2019-12-09 15:02:32 -0700173static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
174 const auto format = create_info.format;
175 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200176
177#ifdef VK_USE_PLATFORM_ANDROID_KHR
178 const VkExternalFormatANDROID *pExternalFormatANDROID = lvl_find_in_chain<VkExternalFormatANDROID>(&create_info);
179 bool isExternalFormatConversion = (pExternalFormatANDROID != nullptr && pExternalFormatANDROID->externalFormat != 0);
180#else
181 bool isExternalFormatConversion = false;
182#endif
183
184 if (FormatIsColor(format) || FormatIsMultiplane(format) || isExternalFormatConversion) {
John Zulaufb58415b2019-12-09 15:02:32 -0700185 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
186 } else {
187 init_range.aspectMask =
188 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
189 }
190 return NormalizeSubresourceRange(create_info, init_range);
191}
192
locke-lunarg296a3c92020-03-25 01:04:29 -0600193IMAGE_STATE::IMAGE_STATE(VkDevice dev, VkImage img, const VkImageCreateInfo *pCreateInfo)
John Zulauff660ad62019-03-23 07:16:05 -0600194 : image(img),
Tony-LunarGf3278f52020-01-31 09:58:26 -0700195 safe_create_info(pCreateInfo),
196 createInfo(*safe_create_info.ptr()),
John Zulauff660ad62019-03-23 07:16:05 -0600197 valid(false),
198 acquired(false),
199 shared_presentable(false),
200 layout_locked(false),
201 get_sparse_reqs_called(false),
202 sparse_metadata_required(false),
203 sparse_metadata_bound(false),
John Zulauff660ad62019-03-23 07:16:05 -0600204 has_ahb_format(false),
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700205 is_swapchain_image(false),
John Zulauff660ad62019-03-23 07:16:05 -0600206 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700207 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -0600208 create_from_swapchain(VK_NULL_HANDLE),
209 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -0600210 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -0700211 range_encoder(full_range),
sfricke-samsung71bc6572020-04-29 15:49:43 -0700212 disjoint(false),
213 plane0_memory_requirements_checked(false),
214 plane1_memory_requirements_checked(false),
215 plane2_memory_requirements_checked(false),
locke-lunarg296a3c92020-03-25 01:04:29 -0600216 subresource_encoder(full_range),
locke-lunargae26eac2020-04-16 15:29:05 -0600217 fragment_encoder(nullptr),
locke-lunarg296a3c92020-03-25 01:04:29 -0600218 store_device_as_workaround(dev), // TODO REMOVE WHEN encoder can be const
unknown08c57af2019-06-21 16:33:35 -0600219 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -0600220 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
221 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
222 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
223 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
224 }
225 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
226 }
227
228 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
229 sparse = true;
230 }
Locked8af3732019-05-10 09:47:56 -0600231
sfricke-samsunge2441192019-11-06 14:07:57 -0800232 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
233 if (externalMemoryInfo) {
234 external_memory_handle = externalMemoryInfo->handleTypes;
235 }
John Zulauff660ad62019-03-23 07:16:05 -0600236}
237
unknown2c877272019-07-11 12:56:50 -0600238bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
239 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
240 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
241 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
242 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
243 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
244 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600245 return is_equal &&
246 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
unknown2c877272019-07-11 12:56:50 -0600247}
248
Jeff Bolz82f854d2019-09-17 14:56:47 -0500249// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
250bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
251 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
252 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
253 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
254 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
255 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
Tony-LunarG28b88132020-05-05 11:25:41 -0600256 is_compatible = is_compatible &&
257 ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) ? IsQueueFamilyIndicesEqual(other_createInfo) : true);
258 is_compatible = is_compatible && IsTilingEqual(other_createInfo);
Jeff Bolz82f854d2019-09-17 14:56:47 -0500259
260 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
261 createInfo.extent.height <= other_createInfo.extent.height &&
262 createInfo.extent.depth <= other_createInfo.extent.depth &&
263 createInfo.arrayLayers <= other_createInfo.arrayLayers;
264 return is_compatible;
265}
266
unknown2c877272019-07-11 12:56:50 -0600267bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
Tony-LunarGe64e4fe2020-02-17 16:21:55 -0700268 if (!is_swapchain_image && !other_image_state->is_swapchain_image &&
269 !(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT))
270 return false;
locke-lunarg5f59e782019-12-19 10:32:23 -0700271 if ((create_from_swapchain == VK_NULL_HANDLE) && binding.mem_state &&
272 (binding.mem_state == other_image_state->binding.mem_state) && (binding.offset == other_image_state->binding.offset) &&
unknown2c877272019-07-11 12:56:50 -0600273 IsCreateInfoEqual(other_image_state->createInfo)) {
274 return true;
275 }
unknowne1661522019-07-11 13:04:18 -0600276 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
277 return true;
278 }
unknown2c877272019-07-11 12:56:50 -0600279 return false;
280}
281
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500282IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
283 : image_view(iv),
284 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700285 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
locke-lunarg296a3c92020-03-25 01:04:29 -0600286 range_generator(im->subresource_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500287 samplerConversion(VK_NULL_HANDLE),
288 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600289 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
290 if (conversionInfo) samplerConversion = conversionInfo->conversion;
291 if (image_state) {
292 // A light normalization of the createInfo range
293 auto &sub_res_range = create_info.subresourceRange;
294 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
295 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
296
297 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700298 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500299 samples = image_state->createInfo.samples;
Benjamin Thautd0bc2a92020-08-25 17:09:09 +0200300
301 if (image_state->has_ahb_format) {
302 // When the image has a external format the views format must be VK_FORMAT_UNDEFINED and it is required to use a sampler
303 // Ycbcr conversion. Thus we can't extract any meaningful information from the format parameter. As a Sampler Ycbcr
304 // conversion must be used the shader type is always float.
305 descriptor_format_bits = DESCRIPTOR_REQ_COMPONENT_TYPE_FLOAT;
306 } else {
307 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
308 }
John Zulauff660ad62019-03-23 07:16:05 -0600309 }
310}
311
locke-lunarg540b2252020-08-03 13:23:36 -0600312bool IMAGE_VIEW_STATE::OverlapSubresource(const IMAGE_VIEW_STATE &compare_view) const {
locke-lunarg540b2252020-08-03 13:23:36 -0600313 if (image_view == compare_view.image_view) {
314 return true;
315 }
locke-lunargdc287022020-08-21 12:03:57 -0600316 if (image_state->image != compare_view.image_state->image) {
317 return false;
318 }
locke-lunarg540b2252020-08-03 13:23:36 -0600319 if (normalized_subresource_range.aspectMask != compare_view.normalized_subresource_range.aspectMask) {
320 return false;
321 }
322
323 // compare if overlap mip level
locke-lunarg540b2252020-08-03 13:23:36 -0600324 if ((normalized_subresource_range.baseMipLevel < compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600325 ((normalized_subresource_range.baseMipLevel + normalized_subresource_range.levelCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600326 compare_view.normalized_subresource_range.baseMipLevel)) {
locke-lunargdc287022020-08-21 12:03:57 -0600327 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600328 }
329
330 if ((normalized_subresource_range.baseMipLevel > compare_view.normalized_subresource_range.baseMipLevel) &&
locke-lunargdc287022020-08-21 12:03:57 -0600331 (normalized_subresource_range.baseMipLevel >=
locke-lunarg540b2252020-08-03 13:23:36 -0600332 (compare_view.normalized_subresource_range.baseMipLevel + compare_view.normalized_subresource_range.levelCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600333 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600334 }
335
336 // compare if overlap array layer
locke-lunarg540b2252020-08-03 13:23:36 -0600337 if ((normalized_subresource_range.baseArrayLayer < compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600338 ((normalized_subresource_range.baseArrayLayer + normalized_subresource_range.layerCount) <=
locke-lunarg540b2252020-08-03 13:23:36 -0600339 compare_view.normalized_subresource_range.baseArrayLayer)) {
locke-lunargdc287022020-08-21 12:03:57 -0600340 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600341 }
342
343 if ((normalized_subresource_range.baseArrayLayer > compare_view.normalized_subresource_range.baseArrayLayer) &&
locke-lunargdc287022020-08-21 12:03:57 -0600344 (normalized_subresource_range.baseArrayLayer >=
locke-lunarg540b2252020-08-03 13:23:36 -0600345 (compare_view.normalized_subresource_range.baseArrayLayer + compare_view.normalized_subresource_range.layerCount))) {
locke-lunargdc287022020-08-21 12:03:57 -0600346 return false;
locke-lunarg540b2252020-08-03 13:23:36 -0600347 }
locke-lunargdc287022020-08-21 12:03:57 -0600348 return true;
locke-lunarg540b2252020-08-03 13:23:36 -0600349}
350
Dave Houltond9611312018-11-19 17:03:36 -0700351uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
352 // uint cast applies floor()
353 return 1u + (uint32_t)log2(std::max({height, width, depth}));
354}
355
356uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
357
358uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
359
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500360bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700361 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700362 if (!image_state) return false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700363
John Zulauf2076e812020-01-08 14:55:54 -0700364 const auto *layout_range_map = GetLayoutRangeMap(imageLayoutMap, image);
365 if (!layout_range_map) return false;
locke-lunargf155ccf2020-02-18 11:34:15 -0700366 // TODO: FindLayouts function should mutate into a ValidatePresentableLayout with the loop wrapping the LogError
367 // from the caller. You can then use decode to add the subresource of the range::begin to the error message.
368
John Zulauf2076e812020-01-08 14:55:54 -0700369 // TODO: what is this test and what is it supposed to do?! -- the logic doesn't match the comment below?!
370
371 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
372 if (layout_range_map->size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700373 return false;
374 }
locke-lunargcba7d5f2019-12-30 16:59:11 -0700375
John Zulauf2076e812020-01-08 14:55:54 -0700376 for (auto entry : *layout_range_map) {
377 layouts.push_back(entry.second);
Tony Barbourdf013b92017-01-25 12:53:48 -0700378 }
379 return true;
380}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700381
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600382// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600383void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600384 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
385 VkImageLayout expected_layout) {
386 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
387 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600388 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600389 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700390 }
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700391 for (const auto &image : image_state.aliasing_images) {
392 auto alias_state = GetImageState(image);
393 // The map state of the aliases should all be in sync, so no need to check the return value
394 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
395 assert(subresource_map);
396 subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout);
397 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700398}
John Zulauff660ad62019-03-23 07:16:05 -0600399
400// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600401void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -0600402 if (disabled[image_layout_validation]) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500403 return;
404 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500405 IMAGE_STATE *image_state = view_state.image_state.get();
406 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700407 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700408 for (const auto &image : image_state->aliasing_images) {
409 image_state = GetImageState(image);
410 subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
411 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
412 }
John Zulauff660ad62019-03-23 07:16:05 -0600413}
414
415// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600416void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600417 const VkImageSubresourceRange &range, VkImageLayout layout) {
418 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
419 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600420 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
Tony-LunarG330cf4c2020-03-04 16:29:03 -0700421 for (const auto &image : image_state.aliasing_images) {
422 auto alias_state = GetImageState(image);
423 subresource_map = GetImageSubresourceLayoutMap(cb_node, *alias_state);
424 assert(subresource_map);
425 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(*alias_state, range), layout);
426 }
John Zulauff660ad62019-03-23 07:16:05 -0600427}
428
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600429void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600430 VkImageLayout layout) {
431 const IMAGE_STATE *image_state = GetImageState(image);
432 if (!image_state) return;
433 SetImageInitialLayout(cb_node, *image_state, range, layout);
434};
435
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600436void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600437 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
438 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600439}
Dave Houltonddd65c52018-05-08 14:58:01 -0600440
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600441// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700442void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
443 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500444 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600445
John Zulauff660ad62019-03-23 07:16:05 -0600446 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600447 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
448 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600449 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 -0600450 sub_range.baseArrayLayer = 0;
451 sub_range.layerCount = image_state->createInfo.extent.depth;
452 }
453
Piers Daniell4fde9b72019-11-27 16:19:46 -0700454 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
455 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
456 SetImageLayout(cb_node, *image_state, sub_range, layout);
457 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
458 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
459 } else {
460 SetImageLayout(cb_node, *image_state, sub_range, layout);
461 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600462}
463
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700464bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
465 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700466 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600467 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100468 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700469 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100470 const char *vuid;
471 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700472 const char *function_name = use_rp2 ? "vkCmdBeginRenderPass2()" : "vkCmdBeginRenderPass()";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100473
474 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600475 LogObjectList objlist(image);
476 objlist.add(renderpass);
477 objlist.add(framebuffer);
478 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700479 skip |=
480 LogError(image, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
481 "%s: RenderPass %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
482 function_name, report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
483 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100484 return skip;
485 }
486
487 auto image_usage = image_state->createInfo.usage;
Ricardo Garcia3f5984c2020-04-09 10:56:34 +0200488 const auto stencil_usage_info = lvl_find_in_chain<VkImageStencilUsageCreateInfo>(image_state->createInfo.pNext);
489 if (stencil_usage_info) {
490 image_usage |= stencil_usage_info->stencilUsage;
491 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100492
493 // Check for layouts that mismatch image usages in the framebuffer
494 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800495 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600496 LogObjectList objlist(image);
497 objlist.add(renderpass);
498 objlist.add(framebuffer);
499 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700500 skip |= LogError(objlist, vuid,
501 "%s: Layout/usage mismatch for attachment %u in %s"
502 " - the %s is %s but the image attached to %s via %s"
503 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
504 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
505 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
506 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100507 }
508
509 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
510 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800511 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600512 LogObjectList objlist(image);
513 objlist.add(renderpass);
514 objlist.add(framebuffer);
515 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700516 skip |= LogError(objlist, vuid,
517 "%s: Layout/usage mismatch for attachment %u in %s"
518 " - the %s is %s but the image attached to %s via %s"
519 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
520 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
521 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
522 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100523 }
524
525 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800526 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600527 LogObjectList objlist(image);
528 objlist.add(renderpass);
529 objlist.add(framebuffer);
530 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700531 skip |= LogError(objlist, vuid,
532 "%s: Layout/usage mismatch for attachment %u in %s"
533 " - the %s is %s but the image attached to %s via %s"
534 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
535 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
536 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
537 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100538 }
539
540 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800541 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600542 LogObjectList objlist(image);
543 objlist.add(renderpass);
544 objlist.add(framebuffer);
545 objlist.add(image_view);
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700546 skip |= LogError(objlist, vuid,
547 "%s: Layout/usage mismatch for attachment %u in %s"
548 " - the %s is %s but the image attached to %s via %s"
549 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
550 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
551 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
552 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100553 }
554
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600555 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100556 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
557 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
558 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
559 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
560 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800561 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600562 LogObjectList objlist(image);
563 objlist.add(renderpass);
564 objlist.add(framebuffer);
565 objlist.add(image_view);
566 skip |= LogError(objlist, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700567 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700568 " - the %s is %s but the image attached to %s via %s"
569 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700570 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700571 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
572 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100573 }
574 } else {
575 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
576 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
577 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
578 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600579 LogObjectList objlist(image);
580 objlist.add(renderpass);
581 objlist.add(framebuffer);
582 objlist.add(image_view);
583 skip |= LogError(objlist, "VUID-vkCmdBeginRenderPass-initialLayout-00896",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700584 "%s: Layout/usage mismatch for attachment %u in %s"
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700585 " - the %s is %s but the image attached to %s via %s"
586 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700587 function_name, attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700588 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
589 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100590 }
591 }
592 return skip;
593}
594
John Zulauf17a01bb2019-08-09 16:41:19 -0600595bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700596 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600597 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600598 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700599 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100601 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100602
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700603 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100604 auto framebuffer = framebuffer_state->framebuffer;
605
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700606 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700607 skip |= LogError(pCB->commandBuffer, kVUID_Core_DrawState_InvalidRenderpass,
608 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700609 }
John Zulauf8e308292018-09-21 11:34:37 -0600610
Tobias Hectorc9057422019-07-23 12:15:52 +0100611 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
612 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
613 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100614 }
615
Tobias Hectorc9057422019-07-23 12:15:52 +0100616 if (attachments != nullptr) {
617 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
618 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
619 auto image_view = attachments[i];
620 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100621
Tobias Hectorc9057422019-07-23 12:15:52 +0100622 if (!view_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600623 LogObjectList objlist(pRenderPassBegin->renderPass);
624 objlist.add(framebuffer_state->framebuffer);
625 objlist.add(image_view);
626 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700627 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
628 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
629 report_data->FormatHandle(image_view).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100630 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100631 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100632
633 const VkImage image = view_state->create_info.image;
634 const IMAGE_STATE *image_state = GetImageState(image);
635
636 if (!image_state) {
Mark Lobodzinskiea561582020-03-16 18:13:56 -0600637 LogObjectList objlist(pRenderPassBegin->renderPass);
638 objlist.add(framebuffer_state->framebuffer);
639 objlist.add(image_view);
640 objlist.add(image);
641 skip |= LogError(objlist, "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700642 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
643 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
644 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
Tobias Hectorc9057422019-07-23 12:15:52 +0100645 continue;
646 }
647 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
648 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
649
Piers Daniell7f894f62020-01-09 16:33:48 -0700650 // Default to expecting stencil in the same layout.
651 auto attachment_stencil_initial_layout = attachment_initial_layout;
652
653 // If a separate layout is specified, look for that.
654 const auto *attachment_description_stencil_layout =
655 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
656 if (attachment_description_stencil_layout) {
657 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
658 }
659
Tobias Hectorc9057422019-07-23 12:15:52 +0100660 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
661 // in common with the non-const version.)
662 const ImageSubresourceLayoutMap *subresource_map =
663 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
664
665 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
666 LayoutUseCheckAndMessage layout_check(subresource_map);
667 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700668 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
Tony Barbour55688172020-09-23 15:19:50 -0700669 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
670 // the next "constant value" range
671 for (; !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -0700672 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700673
John Zulauf5e617452019-11-19 14:44:16 -0700674 // Allow for differing depth and stencil layouts
675 VkImageLayout check_layout = attachment_initial_layout;
676 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
677
678 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700679 subres_skip |= LogError(
680 device, kVUID_Core_DrawState_InvalidRenderpass,
Piers Daniell7f894f62020-01-09 16:33:48 -0700681 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
682 "and the %s layout of the attachment is %s. The layouts must match, or the render "
683 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700684 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100685 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700686 }
John Zulauf5e617452019-11-19 14:44:16 -0700687
Tobias Hectorc9057422019-07-23 12:15:52 +0100688 skip |= subres_skip;
689 }
690
691 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
692 framebuffer, render_pass, i, "initial layout");
693
694 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
695 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100696 }
697
Tobias Hectorc9057422019-07-23 12:15:52 +0100698 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
699 auto &subpass = pRenderPassInfo->pSubpasses[j];
700 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
701 auto &attachment_ref = subpass.pInputAttachments[k];
702 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
703 auto image_view = attachments[attachment_ref.attachment];
704 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100705
Tobias Hectorc9057422019-07-23 12:15:52 +0100706 if (view_state) {
707 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700708 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
709 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100710 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100711 }
712 }
713 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100714
Tobias Hectorc9057422019-07-23 12:15:52 +0100715 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
716 auto &attachment_ref = subpass.pColorAttachments[k];
717 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
718 auto image_view = attachments[attachment_ref.attachment];
719 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100720
Tobias Hectorc9057422019-07-23 12:15:52 +0100721 if (view_state) {
722 auto image = view_state->create_info.image;
723 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
724 framebuffer, render_pass, attachment_ref.attachment,
725 "color attachment layout");
726 if (subpass.pResolveAttachments) {
727 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
728 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
729 attachment_ref.attachment, "resolve attachment layout");
730 }
731 }
732 }
733 }
734
735 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
736 auto &attachment_ref = *subpass.pDepthStencilAttachment;
737 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
738 auto image_view = attachments[attachment_ref.attachment];
739 auto view_state = GetImageViewState(image_view);
740
741 if (view_state) {
742 auto image = view_state->create_info.image;
743 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
744 framebuffer, render_pass, attachment_ref.attachment,
745 "input attachment layout");
746 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100747 }
748 }
749 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700750 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600751 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700752}
753
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600754void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700755 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700756 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
locke-lunargfc78e932020-11-19 17:06:24 -0700757 IMAGE_VIEW_STATE *
758 image_view = GetActiveAttachmentImageViewState(pCB, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600759 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700760 VkImageLayout stencil_layout = kInvalidLayout;
761 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
762 if (attachment_reference_stencil_layout) {
763 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
764 }
765
766 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600767 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700768 }
769}
770
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600771void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
772 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700773 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700774
775 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700776 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700777 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700778 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700779 }
780 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700781 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700782 }
783 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700784 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700785 }
786 }
787}
788
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700789// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
790// 1. Transition into initialLayout state
791// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600792void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700793 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700794 // First transition into initialLayout
795 auto const rpci = render_pass_state->createInfo.ptr();
796 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -0700797 auto *view_state = GetActiveAttachmentImageViewState(cb_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600798 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700799 VkImageLayout stencil_layout = kInvalidLayout;
800 const auto *attachment_description_stencil_layout =
801 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
802 if (attachment_description_stencil_layout) {
803 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
804 }
805
806 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600807 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700808 }
809 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700810 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700811}
812
Dave Houlton10b39482017-03-16 13:18:15 -0600813bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600814 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600815 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600816 }
817 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600818 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600819 }
820 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600821 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600822 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700823 if (0 !=
824 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
825 if (FormatPlaneCount(format) == 1) return false;
826 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600827 return true;
828}
829
Mike Weiblen62d08a32017-03-07 22:18:27 -0700830// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200831bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
832 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600833 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700834 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200835 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600836 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700837
838 switch (layout) {
839 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
840 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600841 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700842 }
843 break;
844 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
845 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600846 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700847 }
848 break;
849 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
850 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600851 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700852 }
853 break;
854 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
855 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600856 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700857 }
858 break;
859 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
860 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600861 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700862 }
863 break;
864 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
865 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600866 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700867 }
868 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600869 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500870 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
871 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
872 }
873 break;
sfricke-samsung9f9ca962020-04-25 02:04:55 -0700874 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
875 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
876 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01658";
877 }
878 break;
879 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
880 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
881 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01659";
882 }
883 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700884 default:
885 // Other VkImageLayout values do not have VUs defined in this context.
886 break;
887 }
888
Dave Houlton8e9f6542018-05-18 12:18:22 -0600889 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700890 skip |= LogError(img_barrier.image, msg_code,
891 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
892 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
893 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700894 }
895 return skip;
896}
897
898// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600899bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
900 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700901 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700902
Petr Krausad0096a2019-08-09 18:35:04 +0200903 // Scoreboard for checking for duplicate and inconsistent barriers to images
904 struct ImageBarrierScoreboardEntry {
905 uint32_t index;
906 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
907 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
908 const VkImageMemoryBarrier *barrier;
909 };
910 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
911 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
912
John Zulauf463c51e2018-05-31 13:29:20 -0600913 // Scoreboard for duplicate layout transition barriers within the list
914 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
915 ImageBarrierScoreboardImageMap layout_transitions;
916
Mike Weiblen62d08a32017-03-07 22:18:27 -0700917 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200918 const auto &img_barrier = pImageMemoryBarriers[i];
919 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700920
John Zulauf463c51e2018-05-31 13:29:20 -0600921 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
922 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
923 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200924 if (img_barrier.oldLayout != img_barrier.newLayout) {
925 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
926 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600927 if (image_it != layout_transitions.end()) {
928 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200929 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600930 if (subres_it != subres_map.end()) {
931 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200932 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
933 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
934 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700935 skip = LogError(
936 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200937 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600938 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
939 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200940 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
941 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
942 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600943 }
944 entry = new_entry;
945 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200946 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600947 }
948 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200949 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600950 }
951 }
952
Petr Krausad0096a2019-08-09 18:35:04 +0200953 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600954 if (image_state) {
955 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200956 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
957 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600958
959 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
960 if (image_state->layout_locked) {
961 // TODO: Add unique id for error when available
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700962 skip |= LogError(
963 img_barrier.image, 0,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -0700964 "%s: Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600965 " 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 -0700966 func_name, report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
Petr Krausad0096a2019-08-09 18:35:04 +0200967 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600968 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600969
John Zulaufa4472282019-08-22 14:44:34 -0600970 const VkImageCreateInfo &image_create_info = image_state->createInfo;
sfricke-samsung79b00482020-04-01 21:15:50 -0700971 const VkFormat image_format = image_create_info.format;
972 const VkImageAspectFlags aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600973 // For a Depth/Stencil image both aspects MUST be set
sfricke-samsung79b00482020-04-01 21:15:50 -0700974 if (FormatIsDepthAndStencil(image_format)) {
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700975 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600976 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
977 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700978 LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-03319",
979 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
980 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
981 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700982 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600983 }
984 } else {
985 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
986 if ((aspect_mask & ds_mask) != (ds_mask)) {
sfricke-samsung38d280b2020-05-16 08:02:56 -0700987 const char *vuid = device_extensions.vk_khr_separate_depth_stencil_layouts
988 ? "VUID-VkImageMemoryBarrier-image-03320"
989 : "VUID-VkImageMemoryBarrier-image-01207";
990 skip |= LogError(img_barrier.image, vuid,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -0700991 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
992 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
993 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
sfricke-samsung79b00482020-04-01 21:15:50 -0700994 string_VkFormat(image_format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600995 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700996 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700997 }
John Zulauff660ad62019-03-23 07:16:05 -0600998
Petr Krausad0096a2019-08-09 18:35:04 +0200999 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
1000 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -06001001 // TODO: Set memory invalid which is in mem_tracker currently
1002 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
1003 // subresource.
John Zulaufcea64cb2020-06-10 17:17:27 -06001004 } else if (subresource_map && !QueueFamilyIsExternal(img_barrier.srcQueueFamilyIndex)) {
John Zulauff660ad62019-03-23 07:16:05 -06001005 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001006 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +02001007 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
Tony Barbour55688172020-09-23 15:19:50 -07001008 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1009 // the next "constant value" range
1010 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001011 const auto &value = *pos;
1012 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001013 subres_skip = LogError(
1014 cb_state->commandBuffer, "VUID-VkImageMemoryBarrier-oldLayout-01197",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001015 "%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 -07001016 "%s layout is %s.",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001017 func_name, report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
John Zulauf5e617452019-11-19 14:44:16 -07001018 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
1019 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -06001020 }
John Zulauf5e617452019-11-19 14:44:16 -07001021 }
John Zulauff660ad62019-03-23 07:16:05 -06001022 skip |= subres_skip;
1023 }
sfricke-samsung79b00482020-04-01 21:15:50 -07001024
1025 // checks color format and (single-plane or non-disjoint)
1026 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
1027 if ((FormatIsColor(image_format) == true) &&
sfricke-samsung71bc6572020-04-29 15:49:43 -07001028 ((FormatIsMultiplane(image_format) == false) || (image_state->disjoint == false))) {
sfricke-samsung79b00482020-04-01 21:15:50 -07001029 if (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT) {
1030 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
1031 ? "VUID-VkImageMemoryBarrier-image-01671"
1032 : "VUID-VkImageMemoryBarrier-image-02902";
1033 skip |= LogError(img_barrier.image, vuid,
1034 "%s: Image barrier %s references %s of format %s that must be only VK_IMAGE_ASPECT_COLOR_BIT, "
1035 "but its aspectMask is 0x%" PRIx32 ".",
1036 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1037 string_VkFormat(image_format), aspect_mask);
1038 }
1039 }
1040
1041 VkImageAspectFlags valid_disjoint_mask =
1042 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 -07001043 if ((FormatIsMultiplane(image_format) == true) && (image_state->disjoint == true) &&
sfricke-samsung79b00482020-04-01 21:15:50 -07001044 ((aspect_mask & valid_disjoint_mask) == 0)) {
1045 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01672",
1046 "%s: Image barrier %s references %s of format %s has aspectMask (0x%" PRIx32
1047 ") but needs to include either an VK_IMAGE_ASPECT_PLANE_*_BIT or VK_IMAGE_ASPECT_COLOR_BIT.",
1048 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1049 string_VkFormat(image_format), aspect_mask);
1050 }
1051
1052 if ((FormatPlaneCount(image_format) == 2) && ((aspect_mask & VK_IMAGE_ASPECT_PLANE_2_BIT) != 0)) {
1053 skip |= LogError(img_barrier.image, "VUID-VkImageMemoryBarrier-image-01673",
1054 "%s: Image barrier %s references %s of format %s has only two planes but included "
1055 "VK_IMAGE_ASPECT_PLANE_2_BIT in its aspectMask (0x%" PRIx32 ").",
1056 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
1057 string_VkFormat(image_format), aspect_mask);
1058 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001059 }
1060 }
1061 return skip;
1062}
1063
John Zulaufe3d1c8a2019-08-12 14:34:58 -06001064bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +02001065 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -07001066
Jeff Bolz6835fda2019-10-06 00:15:34 -05001067 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +02001068 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001069}
1070
John Zulauf6b4aae82018-05-09 13:03:36 -06001071template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001072bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
1073 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001074 using BarrierRecord = QFOTransferBarrier<Barrier>;
1075 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -05001076 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001077 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
1078 const char *barrier_name = BarrierRecord::BarrierName();
1079 const char *handle_name = BarrierRecord::HandleName();
1080 const char *transfer_type = nullptr;
1081 for (uint32_t b = 0; b < barrier_count; b++) {
1082 if (!IsTransferOp(&barriers[b])) continue;
1083 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001084 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001085 !QueueFamilyIsExternal(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001086 const auto found = barrier_sets.release.find(barriers[b]);
1087 if (found != barrier_sets.release.cend()) {
1088 barrier_record = &(*found);
1089 transfer_type = "releasing";
1090 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -06001091 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001092 !QueueFamilyIsExternal(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001093 const auto found = barrier_sets.acquire.find(barriers[b]);
1094 if (found != barrier_sets.acquire.cend()) {
1095 barrier_record = &(*found);
1096 transfer_type = "acquiring";
1097 }
1098 }
1099 if (barrier_record != nullptr) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001100 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOInCB(),
1101 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1102 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
1103 func_name, barrier_name, b, transfer_type, handle_name,
1104 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
1105 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001106 }
1107 }
1108 return skip;
1109}
1110
John Zulaufa4472282019-08-22 14:44:34 -06001111VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
1112 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
1113}
1114
1115const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1116 return device_state.GetImageState(barrier.image);
1117}
1118
1119VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1120 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1121}
1122
1123const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1124 return device_state.GetBufferState(barrier.buffer);
1125}
1126
1127VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1128
John Zulauf6b4aae82018-05-09 13:03:36 -06001129template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001130void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1131 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001132 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001133 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1134 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001135 auto &barrier = barriers[b];
1136 if (IsTransferOp(&barrier)) {
1137 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001138 !QueueFamilyIsExternal(barrier.dstQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001139 barrier_sets.release.emplace(barrier);
1140 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
John Zulaufcea64cb2020-06-10 17:17:27 -06001141 !QueueFamilyIsExternal(barrier.srcQueueFamilyIndex)) {
John Zulaufa4472282019-08-22 14:44:34 -06001142 barrier_sets.acquire.emplace(barrier);
1143 }
1144 }
1145
1146 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1147 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1148 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1149 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1150 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1151 auto handle_state = BarrierHandleState(*this, barrier);
1152 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1153 if (!mode_concurrent) {
1154 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001155 cb_state->queue_submit_functions.emplace_back(
1156 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1157 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1158 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1159 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001160 });
1161 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001162 }
1163 }
1164}
1165
John Zulaufa4472282019-08-22 14:44:34 -06001166bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001167 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001168 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001169 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001170 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001171 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1172 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001173 return skip;
1174}
1175
John Zulaufa4472282019-08-22 14:44:34 -06001176void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1177 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1178 const VkImageMemoryBarrier *pImageMemBarriers) {
1179 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1180 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001181}
1182
1183template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001184bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001185 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001186 // Record to the scoreboard or report that we have a duplication
1187 bool skip = false;
1188 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1189 if (!inserted.second && inserted.first->second != cb_state) {
1190 // 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 -06001191 LogObjectList objlist(cb_state->commandBuffer);
1192 objlist.add(barrier.handle);
1193 objlist.add(inserted.first->second->commandBuffer);
1194 skip = LogWarning(objlist, BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001195 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1196 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier submitted in this batch from %s.",
1197 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1198 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex,
1199 barrier.dstQueueFamilyIndex, report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001200 }
1201 return skip;
1202}
1203
1204template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001205bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1206 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001207 using BarrierRecord = QFOTransferBarrier<Barrier>;
1208 using TypeTag = typename BarrierRecord::Tag;
1209 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001210 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001211 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001212 const char *barrier_name = BarrierRecord::BarrierName();
1213 const char *handle_name = BarrierRecord::HandleName();
1214 // No release should have an extant duplicate (WARNING)
1215 for (const auto &release : cb_barriers.release) {
1216 // Check the global pending release barriers
1217 const auto set_it = global_release_barriers.find(release.handle);
1218 if (set_it != global_release_barriers.cend()) {
1219 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1220 const auto found = set_for_handle.find(release);
1221 if (found != set_for_handle.cend()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001222 skip |= LogWarning(cb_state->commandBuffer, BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
1223 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1224 " to dstQueueFamilyIndex %" PRIu32
1225 " duplicates existing barrier queued for execution, without intervening acquire operation.",
1226 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
1227 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001228 }
1229 }
1230 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1231 }
1232 // Each acquire must have a matching release (ERROR)
1233 for (const auto &acquire : cb_barriers.acquire) {
1234 const auto set_it = global_release_barriers.find(acquire.handle);
1235 bool matching_release_found = false;
1236 if (set_it != global_release_barriers.cend()) {
1237 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1238 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1239 }
1240 if (!matching_release_found) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001241 skip |= LogError(cb_state->commandBuffer, BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
1242 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1243 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1244 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
1245 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -06001246 }
1247 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1248 }
1249 return skip;
1250}
1251
John Zulauf3b04ebd2019-07-18 14:08:11 -06001252bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001253 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001254 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001255 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001256 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1257 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001258 return skip;
1259}
1260
1261template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001262void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001263 using BarrierRecord = QFOTransferBarrier<Barrier>;
1264 using TypeTag = typename BarrierRecord::Tag;
1265 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001266 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001267
1268 // Add release barriers from this submit to the global map
1269 for (const auto &release : cb_barriers.release) {
1270 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1271 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1272 global_release_barriers[release.handle].insert(release);
1273 }
1274
1275 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1276 for (const auto &acquire : cb_barriers.acquire) {
1277 // NOTE: We're not using [] because we don't want to create entries for missing releases
1278 auto set_it = global_release_barriers.find(acquire.handle);
1279 if (set_it != global_release_barriers.end()) {
1280 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1281 set_for_handle.erase(acquire);
1282 if (set_for_handle.size() == 0) { // Clean up empty sets
1283 global_release_barriers.erase(set_it);
1284 }
1285 }
1286 }
1287}
1288
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001289void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001290 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1291 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001292}
1293
John Zulauf6b4aae82018-05-09 13:03:36 -06001294// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001295void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001296
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001297void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001298 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001299 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001300 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001301
Chris Forbes4de4b132017-08-21 11:27:08 -07001302 // For ownership transfers, the barrier is specified twice; as a release
1303 // operation on the yielding queue family, and as an acquire operation
1304 // on the acquiring queue family. This barrier may also include a layout
1305 // transition, which occurs 'between' the two operations. For validation
1306 // purposes it doesn't seem important which side performs the layout
1307 // transition, but it must not be performed twice. We'll arbitrarily
1308 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001309 //
1310 // However, we still need to record initial layout for the "initial layout" validation
1311 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001312
Petr Krausad0096a2019-08-09 18:35:04 +02001313 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001314 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001315 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001316 }
1317}
1318
unknown86bcb3a2019-07-11 13:05:36 -06001319void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001320 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001321 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1322 const auto &image_create_info = image_state->createInfo;
1323
1324 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1325 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1326 // for all (potential) layer sub_resources.
1327 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1328 normalized_isr.baseArrayLayer = 0;
1329 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1330 }
1331
Michael Spang8af7c102020-05-03 20:50:09 -04001332 VkImageLayout initial_layout = mem_barrier.oldLayout;
1333
1334 // Layout transitions in external instance are not tracked, so don't validate initial layout.
John Zulaufcea64cb2020-06-10 17:17:27 -06001335 if (QueueFamilyIsExternal(mem_barrier.srcQueueFamilyIndex)) {
Michael Spang8af7c102020-05-03 20:50:09 -04001336 initial_layout = VK_IMAGE_LAYOUT_UNDEFINED;
1337 }
1338
John Zulauf2be3fe02019-12-30 09:48:02 -07001339 if (is_release_op) {
1340 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1341 } else {
Michael Spang8af7c102020-05-03 20:50:09 -04001342 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, initial_layout);
John Zulauf2be3fe02019-12-30 09:48:02 -07001343 }
unknown86bcb3a2019-07-11 13:05:36 -06001344}
1345
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001346bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1347 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1348 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1349 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06001350 if (disabled[image_layout_validation]) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001351 assert(cb_node);
1352 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001353 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001354 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001355
John Zulauff660ad62019-03-23 07:16:05 -06001356 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1357 if (subresource_map) {
1358 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001359 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
Tony Barbour55688172020-09-23 15:19:50 -07001360 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
1361 // the next "constant value" range
1362 for (auto pos = subresource_map->Find(range); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07001363 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001364 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001365 subres_skip |= LogError(cb_node->commandBuffer, layout_mismatch_msg_code,
1366 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1367 "%s layout %s.",
1368 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1369 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1370 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001371 }
John Zulauf5e617452019-11-19 14:44:16 -07001372 }
John Zulauff660ad62019-03-23 07:16:05 -06001373 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001374 }
John Zulauff660ad62019-03-23 07:16:05 -06001375
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001376 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1377 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1378 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001379 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1380 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001381 skip |= LogPerformanceWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
1382 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
1383 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001384 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001385 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001386 if (image_state->shared_presentable) {
1387 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07001388 skip |=
1389 LogError(device, layout_invalid_msg_code,
1390 "%s: Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1391 caller, string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001392 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001393 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001394 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001395 *error = true;
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001396 skip |= LogError(cb_node->commandBuffer, layout_invalid_msg_code,
1397 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1398 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1399 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001400 }
1401 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001402 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001403}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001404bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001405 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1406 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001407 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001408 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1409 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1410}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001411
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001412void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001413 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001414 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001415 if (!renderPass) return;
1416
Tobias Hectorbbb12282018-10-22 15:17:59 +01001417 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001418 if (framebuffer_state) {
1419 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
locke-lunargfc78e932020-11-19 17:06:24 -07001420 auto *view_state = GetActiveAttachmentImageViewState(pCB, i);
John Zulauf8e308292018-09-21 11:34:37 -06001421 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001422 VkImageLayout stencil_layout = kInvalidLayout;
1423 const auto *attachment_description_stencil_layout =
1424 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1425 if (attachment_description_stencil_layout) {
1426 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1427 }
Piers Daniell4fde9b72019-11-27 16:19:46 -07001428 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001429 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001430 }
1431 }
1432}
Dave Houltone19e20d2018-02-02 16:32:41 -07001433
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001434#ifdef VK_USE_PLATFORM_ANDROID_KHR
1435// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1436// This could also move into a seperate core_validation_android.cpp file... ?
1437
1438//
1439// AHB-specific validation within non-AHB APIs
1440//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001441bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001442 bool skip = false;
1443
1444 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1445 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001446 if (0 != ext_fmt_android->externalFormat) {
1447 if (VK_FORMAT_UNDEFINED != create_info->format) {
1448 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001449 LogError(device, "VUID-VkImageCreateInfo-pNext-01974",
1450 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
1451 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
Dave Houltond9611312018-11-19 17:03:36 -07001452 }
1453
1454 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001455 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02396",
1456 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1457 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Dave Houltond9611312018-11-19 17:03:36 -07001458 }
1459
1460 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001461 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02397",
1462 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001463 "non-zero externalFormat, but usage includes bits (0x%" PRIx64
1464 ") other than VK_IMAGE_USAGE_SAMPLED_BIT.",
1465 create_info->usage);
Dave Houltond9611312018-11-19 17:03:36 -07001466 }
1467
1468 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001469 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02398",
1470 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1471 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
Dave Houltond9611312018-11-19 17:03:36 -07001472 }
1473 }
1474
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001475 if ((0 != ext_fmt_android->externalFormat) &&
1476 (ahb_ext_formats_map.find(ext_fmt_android->externalFormat) == ahb_ext_formats_map.end())) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001477 skip |= LogError(device, "VUID-VkExternalFormatANDROID-externalFormat-01894",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001478 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat (%" PRIu64
1479 ") which has "
1480 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().",
1481 ext_fmt_android->externalFormat);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001482 }
1483 }
1484
Dave Houltond9611312018-11-19 17:03:36 -07001485 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001486 if (VK_FORMAT_UNDEFINED == create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001487 skip |=
1488 LogError(device, "VUID-VkImageCreateInfo-pNext-01975",
1489 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
1490 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
Dave Houltond9611312018-11-19 17:03:36 -07001491 }
1492 }
1493
1494 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1495 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1496 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001497 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001498 LogError(device, "VUID-VkImageCreateInfo-pNext-02393",
1499 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1500 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1501 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001502 }
1503
1504 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001505 skip |= LogError(device, "VUID-VkImageCreateInfo-pNext-02394",
1506 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
1507 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1508 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1509 create_info->mipLevels, FullMipChainLevels(create_info->extent));
Dave Houltond9611312018-11-19 17:03:36 -07001510 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001511 }
1512
1513 return skip;
1514}
1515
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001516bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001517 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001518 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001519
1520 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001521 if (VK_FORMAT_UNDEFINED != create_info->format) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001522 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02399",
1523 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001524 "format member is %s and must be VK_FORMAT_UNDEFINED.",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001525 string_VkFormat(create_info->format));
Dave Houltond9611312018-11-19 17:03:36 -07001526 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001527
Dave Houltond9611312018-11-19 17:03:36 -07001528 // Chain must include a compatible ycbcr conversion
1529 bool conv_found = false;
1530 uint64_t external_format = 0;
1531 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1532 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001533 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001534 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001535 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001536 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001537 }
Dave Houltond9611312018-11-19 17:03:36 -07001538 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001539 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001540 skip |= LogError(create_info->image, "VUID-VkImageViewCreateInfo-image-02400",
Spencer Frickef48ad4a2020-04-09 00:07:39 -07001541 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct with "
1542 "an externalFormat (%" PRIu64
1543 ") but needs a chained VkSamplerYcbcrConversionInfo struct with a VkSamplerYcbcrConversion created "
1544 "with the same external format.",
1545 image_state->ahb_format);
Dave Houltond9611312018-11-19 17:03:36 -07001546 }
1547
1548 // Errors in create_info swizzles
sfricke-samsungbd0e8052020-06-06 01:36:39 -07001549 if (IsIdentitySwizzle(create_info->components) == false) {
1550 skip |= LogError(
1551 create_info->image, "VUID-VkImageViewCreateInfo-image-02401",
1552 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1553 "includes one or more non-identity component swizzles, r swizzle = %s, g swizzle = %s, b swizzle = %s, a swizzle "
1554 "= %s.",
1555 string_VkComponentSwizzle(create_info->components.r), string_VkComponentSwizzle(create_info->components.g),
1556 string_VkComponentSwizzle(create_info->components.b), string_VkComponentSwizzle(create_info->components.a));
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001557 }
1558 }
Dave Houltond9611312018-11-19 17:03:36 -07001559
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001560 return skip;
1561}
1562
John Zulaufa26d3c82019-08-14 16:09:08 -06001563bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001564 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001565
John Zulaufa26d3c82019-08-14 16:09:08 -06001566 const IMAGE_STATE *image_state = GetImageState(image);
sfricke-samsung013f1ef2020-05-14 22:56:20 -07001567 if (image_state != nullptr) {
1568 if (image_state->external_ahb && (0 == image_state->GetBoundMemory().size())) {
1569 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-01895",
1570 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
1571 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1572 "bound to memory.");
1573 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001574 }
1575 return skip;
1576}
1577
1578#else
1579
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001580bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001581 return false;
1582}
1583
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001584bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001585
John Zulaufa26d3c82019-08-14 16:09:08 -06001586bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001587
1588#endif // VK_USE_PLATFORM_ANDROID_KHR
1589
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001590bool CoreChecks::ValidateImageFormatFeatures(const VkImageCreateInfo *pCreateInfo) const {
1591 bool skip = false;
1592
1593 // validates based on imageCreateFormatFeatures from vkspec.html#resources-image-creation-limits
1594 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
1595 const VkImageTiling image_tiling = pCreateInfo->tiling;
1596 const VkFormat image_format = pCreateInfo->format;
1597
1598 if (image_format == VK_FORMAT_UNDEFINED) {
1599 // VU 01975 states format can't be undefined unless an android externalFormat
1600#ifdef VK_USE_PLATFORM_ANDROID_KHR
1601 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext);
1602 if ((image_tiling == VK_IMAGE_TILING_OPTIMAL) && (ext_fmt_android != nullptr) && (0 != ext_fmt_android->externalFormat)) {
1603 auto it = ahb_ext_formats_map.find(ext_fmt_android->externalFormat);
1604 if (it != ahb_ext_formats_map.end()) {
1605 tiling_features = it->second;
1606 }
1607 }
1608#endif
1609 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1610 uint64_t drm_format_modifier = 0;
1611 const VkImageDrmFormatModifierExplicitCreateInfoEXT *drm_explicit =
1612 lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1613 const VkImageDrmFormatModifierListCreateInfoEXT *drm_implicit =
1614 lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1615
1616 if (drm_explicit != nullptr) {
1617 drm_format_modifier = drm_explicit->drmFormatModifier;
1618 } else {
1619 // VUID 02261 makes sure its only explict or implict in parameter checking
1620 assert(drm_implicit != nullptr);
1621 for (uint32_t i = 0; i < drm_implicit->drmFormatModifierCount; i++) {
1622 drm_format_modifier |= drm_implicit->pDrmFormatModifiers[i];
1623 }
1624 }
1625
1626 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
1627 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
1628 nullptr};
1629 format_properties_2.pNext = (void *)&drm_properties_list;
1630 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Lionel Landwerlin09351a72020-06-22 18:15:59 +03001631 std::vector<VkDrmFormatModifierPropertiesEXT> drm_properties;
1632 drm_properties.resize(drm_properties_list.drmFormatModifierCount);
1633 drm_properties_list.pDrmFormatModifierProperties = &drm_properties[0];
1634 DispatchGetPhysicalDeviceFormatProperties2(physical_device, image_format, &format_properties_2);
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001635
1636 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
1637 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_modifier) != 0) {
1638 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
1639 }
1640 }
1641 } else {
1642 VkFormatProperties format_properties = GetPDFormatProperties(image_format);
1643 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
1644 : format_properties.optimalTilingFeatures;
1645 }
1646
Spencer Fricke3c2a8232020-04-19 18:47:25 -07001647 // Lack of disjoint format feature support while using the flag
1648 if (FormatIsMultiplane(image_format) && ((pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT) != 0) &&
1649 ((tiling_features & VK_FORMAT_FEATURE_DISJOINT_BIT) == 0)) {
1650 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateFormatFeatures-02260",
1651 "vkCreateImage(): can't use VK_IMAGE_CREATE_DISJOINT_BIT because %s doesn't support "
1652 "VK_FORMAT_FEATURE_DISJOINT_BIT based on imageCreateFormatFeatures.",
1653 string_VkFormat(pCreateInfo->format));
1654 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001655
1656 return skip;
1657}
1658
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001659bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001660 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001661 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001662
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001663 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001664 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001665 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1666 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001667 return LogError(device, "VUID-VkImageCreateInfo-format-00943",
1668 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001669 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001670 }
1671
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001672 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1673 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001674 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-00949",
1675 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1676 "flag bit is set");
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001677 }
1678
1679 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001680 skip |= LogError(device, "VUID-VkImageCreateInfo-imageType-00954",
1681 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1682 "height (%d) and arrayLayers (%d) must be >= 6.",
1683 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001684 }
Dave Houlton130c0212018-01-29 13:39:56 -07001685 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001686
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001687 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001688 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1689 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1690 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001691 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00964",
1692 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1693 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001694 }
1695
1696 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001697 skip |= LogError(device, "VUID-VkImageCreateInfo-usage-00965",
1698 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1699 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001700 }
1701
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02001702 if (device_extensions.vk_ext_fragment_density_map || device_extensions.vk_ext_fragment_density_map_2) {
ByumjinConffx991b6062019-08-14 15:17:53 -07001703 uint32_t ceiling_width =
1704 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1705 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1706 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1707 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001708 LogError(device, "VUID-VkImageCreateInfo-usage-02559",
1709 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1710 "ceiling of device "
1711 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1712 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1713 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
ByumjinConffx991b6062019-08-14 15:17:53 -07001714 }
1715
1716 uint32_t ceiling_height =
1717 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1718 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1719 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1720 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001721 LogError(device, "VUID-VkImageCreateInfo-usage-02560",
1722 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1723 "ceiling of device "
1724 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1725 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1726 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
ByumjinConffx991b6062019-08-14 15:17:53 -07001727 }
1728 }
1729
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001730 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001731 VkResult result = VK_SUCCESS;
1732 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1733 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1734 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1735 &format_limits);
1736 } else {
Lionel Landwerlind8b1aa12020-06-22 21:22:05 +03001737 auto modifier_list = lvl_find_in_chain<VkImageDrmFormatModifierListCreateInfoEXT>(pCreateInfo->pNext);
1738 auto explicit_modifier = lvl_find_in_chain<VkImageDrmFormatModifierExplicitCreateInfoEXT>(pCreateInfo->pNext);
1739 if (modifier_list) {
1740 for (uint32_t i = 0; i < modifier_list->drmFormatModifierCount; i++) {
1741 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1742 drm_format_modifier.drmFormatModifier = modifier_list->pDrmFormatModifiers[i];
1743 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1744 image_format_info.type = pCreateInfo->imageType;
1745 image_format_info.format = pCreateInfo->format;
1746 image_format_info.tiling = pCreateInfo->tiling;
1747 image_format_info.usage = pCreateInfo->usage;
1748 image_format_info.flags = pCreateInfo->flags;
1749 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1750
1751 result =
1752 DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1753 format_limits = image_format_properties.imageFormatProperties;
1754
1755 /* The application gives a list of modifier and the driver
1756 * selects one. If one is wrong, stop there.
1757 */
1758 if (result != VK_SUCCESS) break;
1759 }
1760 } else if (explicit_modifier) {
1761 auto drm_format_modifier = lvl_init_struct<VkPhysicalDeviceImageDrmFormatModifierInfoEXT>();
1762 drm_format_modifier.drmFormatModifier = explicit_modifier->drmFormatModifier;
1763 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>(&drm_format_modifier);
1764 image_format_info.type = pCreateInfo->imageType;
1765 image_format_info.format = pCreateInfo->format;
1766 image_format_info.tiling = pCreateInfo->tiling;
1767 image_format_info.usage = pCreateInfo->usage;
1768 image_format_info.flags = pCreateInfo->flags;
1769 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1770
1771 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1772 format_limits = image_format_properties.imageFormatProperties;
1773 }
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001774 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001775
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001776 // 1. vkGetPhysicalDeviceImageFormatProperties[2] only success code is VK_SUCCESS
1777 // 2. If call returns an error, then "imageCreateImageFormatPropertiesList" is defined to be the empty list
1778 // 3. All values in 02251 are undefined if "imageCreateImageFormatPropertiesList" is empty.
1779 if (result != VK_SUCCESS) {
1780 // External memory will always have a "imageCreateImageFormatPropertiesList" so skip
Lockee87f87c2019-04-23 17:53:10 -06001781#ifdef VK_USE_PLATFORM_ANDROID_KHR
1782 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1783#endif // VK_USE_PLATFORM_ANDROID_KHR
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001784 skip |= LogError(device, "VUID-VkImageCreateInfo-imageCreateMaxMipLevels-02251",
Spencer Frickec46fc6d2020-04-16 06:23:05 -07001785 "vkCreateImage(): Format %s is not supported for this combination of parameters and "
sfricke-samsunga6d30f62020-06-20 20:22:00 -07001786 "VkGetPhysicalDeviceImageFormatProperties returned back %s.",
1787 string_VkFormat(pCreateInfo->format), string_VkResult(result));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001788 } else {
1789 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1790 const char *format_string = string_VkFormat(pCreateInfo->format);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001791 skip |= LogError(device, "VUID-VkImageCreateInfo-mipLevels-02255",
1792 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1793 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001794 }
Dave Houlton130c0212018-01-29 13:39:56 -07001795
Dave Houltona585d132019-01-18 13:05:42 -07001796 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1797 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1798 (uint64_t)pCreateInfo->samples;
Mark Young0ec6b062020-11-19 15:32:17 -07001799 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * static_cast<double>(texel_count));
Dave Houlton130c0212018-01-29 13:39:56 -07001800
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001801 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001802 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001803 uint64_t ig_mask = imageGranularity - 1;
1804 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001805
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001806 if (total_size > format_limits.maxResourceSize) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001807 skip |= LogWarning(device, kVUID_Core_Image_InvalidFormatLimitsViolation,
1808 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1809 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1810 total_size, format_limits.maxResourceSize);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001811 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001812
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001813 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001814 skip |= LogError(device, "VUID-VkImageCreateInfo-arrayLayers-02256",
1815 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1816 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001817 }
1818
1819 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001820 skip |= LogError(device, "VUID-VkImageCreateInfo-samples-02258",
1821 "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
1822 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001823 }
sfricke-samsung612f3622020-06-20 20:42:46 -07001824
1825 if (pCreateInfo->extent.width > format_limits.maxExtent.width) {
1826 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02252",
1827 "vkCreateImage(): extent.width %u exceeds allowable maximum image extent width %u.",
1828 pCreateInfo->extent.width, format_limits.maxExtent.width);
1829 }
1830
1831 if (pCreateInfo->extent.height > format_limits.maxExtent.height) {
1832 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02253",
1833 "vkCreateImage(): extent.height %u exceeds allowable maximum image extent height %u.",
1834 pCreateInfo->extent.height, format_limits.maxExtent.height);
1835 }
1836
1837 if (pCreateInfo->extent.depth > format_limits.maxExtent.depth) {
1838 skip |= LogError(device, "VUID-VkImageCreateInfo-extent-02254",
1839 "vkCreateImage(): extent.depth %u exceeds allowable maximum image extent depth %u.",
1840 pCreateInfo->extent.depth, format_limits.maxExtent.depth);
1841 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001842 }
1843
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001844 // Tests for "Formats requiring sampler YCBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
sfricke-samsungcead0802020-01-30 22:20:10 -08001845 if (FormatRequiresYcbcrConversion(pCreateInfo->format)) {
1846 if (!enabled_features.ycbcr_image_array_features.ycbcrImageArrays && pCreateInfo->arrayLayers != 1) {
1847 const char *error_vuid = (device_extensions.vk_ext_ycbcr_image_arrays) ? "VUID-VkImageCreateInfo-format-02653"
1848 : "VUID-VkImageCreateInfo-format-02564";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001849 skip |= LogError(device, error_vuid,
1850 "vkCreateImage(): arrayLayers = %d, but when the ycbcrImagesArrays feature is not enabled and using a "
1851 "YCbCr Conversion format, arrayLayers must be 1",
1852 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001853 }
1854
1855 if (pCreateInfo->mipLevels != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001856 skip |= LogError(device, "VUID-VkImageCreateInfo-format-02561",
1857 "vkCreateImage(): mipLevels = %d, but when using a YCbCr Conversion format, mipLevels must be 1",
1858 pCreateInfo->arrayLayers);
sfricke-samsungcead0802020-01-30 22:20:10 -08001859 }
1860
1861 if (pCreateInfo->samples != VK_SAMPLE_COUNT_1_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001862 skip |= LogError(
1863 device, "VUID-VkImageCreateInfo-format-02562",
sfricke-samsungcead0802020-01-30 22:20:10 -08001864 "vkCreateImage(): samples = %s, but when using a YCbCr Conversion format, samples must be VK_SAMPLE_COUNT_1_BIT",
1865 string_VkSampleCountFlagBits(pCreateInfo->samples));
1866 }
1867
1868 if (pCreateInfo->imageType != VK_IMAGE_TYPE_2D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001869 skip |= LogError(
1870 device, "VUID-VkImageCreateInfo-format-02563",
sfricke-samsungcead0802020-01-30 22:20:10 -08001871 "vkCreateImage(): imageType = %s, but when using a YCbCr Conversion format, imageType must be VK_IMAGE_TYPE_2D ",
1872 string_VkImageType(pCreateInfo->imageType));
1873 }
1874 }
1875
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001876 if (device_extensions.vk_khr_maintenance2) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001877 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT) {
sfricke-samsungb764f092020-05-25 15:05:36 -07001878 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC(pCreateInfo->format) ||
Lenny Komowb79f04a2017-09-18 17:07:00 -06001879 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001880 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01572",
1881 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1882 "format must be block, ETC or ASTC compressed, but is %s",
1883 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001884 }
1885 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
Spencer Fricke48db59b2020-03-23 10:31:46 -07001886 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01573",
1887 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT, "
1888 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001889 }
1890 }
1891 }
1892
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001893 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06001894 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1895 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices",
1896 "VUID-VkImageCreateInfo-sharingMode-01420");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001897 }
1898
unknown2c877272019-07-11 12:56:50 -06001899 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1900 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1901 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07001902 LogError(device, "VUID-VkImageCreateInfo-format-01577",
1903 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1904 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
unknown2c877272019-07-11 12:56:50 -06001905 }
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001906
sfricke-samsungddaf72b2020-06-23 21:39:28 -07001907 const auto swapchain_create_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1908 if (swapchain_create_info != nullptr) {
1909 if (swapchain_create_info->swapchain != VK_NULL_HANDLE) {
1910 const SWAPCHAIN_NODE *swapchain_state = GetSwapchainState(swapchain_create_info->swapchain);
1911 const VkSwapchainCreateFlagsKHR swapchain_flags = swapchain_state->createInfo.flags;
1912
1913 // Validate rest of Swapchain Image create check that require swapchain state
1914 const char *vuid = "VUID-VkImageSwapchainCreateInfoKHR-swapchain-00995";
1915 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR) != 0) &&
1916 ((pCreateInfo->flags & VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT) == 0)) {
1917 skip |= LogError(
1918 device, vuid,
1919 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR flag so "
1920 "all swapchain images must have the VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT flag set.");
1921 }
1922 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR) != 0) &&
1923 ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) == 0)) {
1924 skip |= LogError(device, vuid,
1925 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag so all "
1926 "swapchain images must have the VK_IMAGE_CREATE_PROTECTED_BIT flag set.");
1927 }
1928 const VkImageCreateFlags mutable_flags = (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT | VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR);
1929 if (((swapchain_flags & VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR) != 0) &&
1930 ((pCreateInfo->flags & mutable_flags) != mutable_flags)) {
1931 skip |= LogError(device, vuid,
1932 "vkCreateImage(): Swapchain was created with VK_SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR flag so "
1933 "all swapchain images must have the VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT and "
1934 "VK_IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR flags both set.");
1935 }
1936 }
1937 }
1938
sfricke-samsungedce77a2020-07-03 22:35:13 -07001939 if ((pCreateInfo->flags & VK_IMAGE_CREATE_PROTECTED_BIT) != 0) {
1940 if (enabled_features.core11.protectedMemory == VK_FALSE) {
1941 skip |= LogError(device, "VUID-VkImageCreateInfo-flags-01890",
1942 "vkCreateImage(): the protectedMemory device feature is disabled: Images cannot be created with the "
1943 "VK_IMAGE_CREATE_PROTECTED_BIT set.");
1944 }
1945 const VkImageCreateFlags invalid_flags =
1946 VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT;
1947 if ((pCreateInfo->flags & invalid_flags) != 0) {
1948 skip |= LogError(device, "VUID-VkImageCreateInfo-None-01891",
1949 "vkCreateImage(): VK_IMAGE_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at same "
1950 "time (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | "
1951 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT).");
1952 }
1953 }
1954
Spencer Fricke6bba8c72020-04-06 07:41:21 -07001955 skip |= ValidateImageFormatFeatures(pCreateInfo);
1956
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001957 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001958}
1959
John Zulauf7eeb6f72019-06-17 11:56:36 -06001960void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1961 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1962 if (VK_SUCCESS != result) return;
1963
1964 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001965 auto image_state = Get<IMAGE_STATE>(*pImage);
1966 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001967}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001968
Jeff Bolz5c801d12019-10-09 10:38:45 -05001969bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001970 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001971 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001972 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001973 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001974 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001975 }
1976 return skip;
1977}
1978
John Zulauf7eeb6f72019-06-17 11:56:36 -06001979void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1980 // Clean up validation specific data
1981 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001982
locke-lunargcba7d5f2019-12-30 16:59:11 -07001983 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001984
1985 // Clean up generic image state
1986 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001987}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001988
sfricke-samsungcd924d92020-05-20 23:51:17 -07001989bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
1990 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001991 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07001992 const VkImage image = image_state->image;
1993 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001994
1995 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07001996 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
1997 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001998 }
1999
sfricke-samsungcd924d92020-05-20 23:51:17 -07002000 if (FormatIsDepthOrStencil(format)) {
2001 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2002 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2003 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2004 } else if (FormatIsCompressed(format)) {
2005 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2006 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2007 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002008 }
2009
2010 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002011 skip |=
2012 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2013 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2014 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002015 }
2016 return skip;
2017}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002018
John Zulauf07288512019-07-05 11:09:50 -06002019bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2020 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2021 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002022 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002023 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2024 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002025 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2026 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2027 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002028 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002029
2030 } else {
2031 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2032 if (!device_extensions.vk_khr_shared_presentable_image) {
2033 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002034 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2035 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2036 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002037 }
2038 } else {
2039 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2040 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002041 skip |= LogError(
2042 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002043 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2044 func_name, string_VkImageLayout(dest_image_layout));
2045 }
2046 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002047 }
2048
John Zulauff660ad62019-03-23 07:16:05 -06002049 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002050 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002051 if (subresource_map) {
2052 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002053 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002054 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002055 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2056 // the next "constant value" range
2057 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002058 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002059 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2060 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2061 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2062 } else {
2063 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002064 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002065 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2066 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2067 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2068 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002069 }
John Zulauf5e617452019-11-19 14:44:16 -07002070 }
John Zulauff660ad62019-03-23 07:16:05 -06002071 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002072 }
2073
2074 return skip;
2075}
2076
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002077bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2078 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002079 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002080 bool skip = false;
2081 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002082 const auto *cb_node = GetCBState(commandBuffer);
2083 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002084 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002085 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002086 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002087 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002088 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002089 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002090 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2091 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002092 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002093 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002094 skip |=
2095 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2096 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2097 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002098 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002099 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002100 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002101 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002102 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002103 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002104 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2105 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2106 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2107 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2108 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2109 string_VkFormat(image_state->createInfo.format));
2110 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002111 }
2112 return skip;
2113}
2114
John Zulaufeabb4462019-07-05 14:13:03 -06002115void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2116 const VkClearColorValue *pColor, uint32_t rangeCount,
2117 const VkImageSubresourceRange *pRanges) {
2118 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2119
2120 auto cb_node = GetCBState(commandBuffer);
2121 auto image_state = GetImageState(image);
2122 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002123 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002124 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002125 }
2126 }
2127}
2128
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002129bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2130 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002131 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002132 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002133
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002134 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002135 const auto *cb_node = GetCBState(commandBuffer);
2136 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002137 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002138 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002139 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002140 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002141 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002142 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002143 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002144 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002145 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002146 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002147 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002148 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002149 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2150 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2151 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2152 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002153
2154 bool any_include_aspect_depth_bit = false;
2155 bool any_include_aspect_stencil_bit = false;
2156
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002157 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002158 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002159 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002160 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002161 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002162 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2163 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002164 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2165 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2166 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2167 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002168 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002169 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2170 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002171 if (FormatHasDepth(image_format) == false) {
2172 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2173 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2174 "doesn't have a depth component.",
2175 i, string_VkFormat(image_format));
2176 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002177 }
2178 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2179 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002180 if (FormatHasStencil(image_format) == false) {
2181 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2182 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2183 "%s doesn't have a stencil component.",
2184 i, string_VkFormat(image_format));
2185 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002186 }
2187 }
2188 if (any_include_aspect_stencil_bit) {
2189 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2190 if (image_stencil_struct != nullptr) {
2191 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2192 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002193 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2194 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2195 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2196 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002197 }
2198 } else {
2199 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002200 skip |= LogError(
2201 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002202 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2203 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2204 "in VkImageCreateInfo::usage used to create image");
2205 }
2206 }
2207 }
2208 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002209 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2210 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2211 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002212 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002213 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002214 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2215 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002216 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002217 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002218 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002219 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2220 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2221 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2222 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002223 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002224 }
2225 return skip;
2226}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002227
John Zulaufeabb4462019-07-05 14:13:03 -06002228void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2229 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2230 const VkImageSubresourceRange *pRanges) {
2231 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2232 auto cb_node = GetCBState(commandBuffer);
2233 auto image_state = GetImageState(image);
2234 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002235 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002236 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002237 }
2238 }
2239}
2240
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002241// Returns true if [x, xoffset] and [y, yoffset] overlap
2242static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2243 bool result = false;
2244 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2245 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2246
2247 if (intersection_max > intersection_min) {
2248 result = true;
2249 }
2250 return result;
2251}
2252
Jeff Leger178b1e52020-10-05 12:22:23 -04002253// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002254// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002255template <typename RegionType>
2256static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002257 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002258
Dave Houltonc991cc92018-03-06 11:08:51 -07002259 // Separate planes within a multiplane image cannot intersect
2260 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002261 return result;
2262 }
2263
Dave Houltonc991cc92018-03-06 11:08:51 -07002264 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2265 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2266 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002267 result = true;
2268 switch (type) {
2269 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002270 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002271 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002272 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002273 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002274 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002275 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002276 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002277 break;
2278 default:
2279 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2280 assert(false);
2281 }
2282 }
2283 return result;
2284}
2285
Dave Houltonfc1a4052017-04-27 14:32:45 -06002286// Returns non-zero if offset and extent exceed image extents
2287static const uint32_t x_bit = 1;
2288static const uint32_t y_bit = 2;
2289static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002290static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002291 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002292 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002293 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2294 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002295 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002296 }
2297 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2298 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002299 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002300 }
2301 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2302 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002303 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002304 }
2305 return result;
2306}
2307
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002308// Test if two VkExtent3D structs are equivalent
2309static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2310 bool result = true;
2311 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2312 (extent->depth != other_extent->depth)) {
2313 result = false;
2314 }
2315 return result;
2316}
2317
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002318// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002319static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002320 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2321}
2322
2323// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002324VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002325 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2326 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002327 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002328 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002329 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002330 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002331 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002332 granularity.width *= block_size.width;
2333 granularity.height *= block_size.height;
2334 }
2335 }
2336 return granularity;
2337}
2338
2339// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2340static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2341 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002342 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2343 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002344 valid = false;
2345 }
2346 return valid;
2347}
2348
2349// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002350bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002351 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002352 bool skip = false;
2353 VkExtent3D offset_extent = {};
2354 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2355 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2356 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002357 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002358 // 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 -07002359 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002360 skip |= LogError(cb_node->commandBuffer, vuid,
2361 "%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 "
2362 "image transfer granularity is (w=0, h=0, d=0).",
2363 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002364 }
2365 } else {
2366 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2367 // integer multiples of the image transfer granularity.
2368 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002369 skip |= LogError(cb_node->commandBuffer, vuid,
2370 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2371 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2372 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2373 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002374 }
2375 }
2376 return skip;
2377}
2378
2379// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002380bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002381 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002382 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002383 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002384 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002385 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2386 // subresource extent.
2387 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002388 skip |= LogError(cb_node->commandBuffer, vuid,
2389 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2390 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2391 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2392 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002393 }
2394 } else {
2395 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2396 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2397 // subresource extent dimensions.
2398 VkExtent3D offset_extent_sum = {};
2399 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2400 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2401 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002402 bool x_ok = true;
2403 bool y_ok = true;
2404 bool z_ok = true;
2405 switch (image_type) {
2406 case VK_IMAGE_TYPE_3D:
2407 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2408 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002409 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002410 case VK_IMAGE_TYPE_2D:
2411 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2412 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002413 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002414 case VK_IMAGE_TYPE_1D:
2415 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2416 (subresource_extent->width == offset_extent_sum.width));
2417 break;
2418 default:
2419 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2420 assert(false);
2421 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002423 skip |=
2424 LogError(cb_node->commandBuffer, vuid,
2425 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2426 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2427 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2428 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2429 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2430 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002431 }
2432 }
2433 return skip;
2434}
2435
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002436bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002437 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002438 bool skip = false;
2439 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002440 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2441 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002442 }
2443 return skip;
2444}
2445
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002446bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002447 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002448 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002449 bool skip = false;
2450 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2451 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002452 skip |= LogError(cb_node->commandBuffer, vuid,
2453 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2454 "%u, but provided %s has %u array layers.",
2455 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2456 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002457 }
2458 return skip;
2459}
2460
Jeff Leger178b1e52020-10-05 12:22:23 -04002461// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2462template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002463bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002464 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002465 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002466 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002467 VkExtent3D granularity = GetScaledItg(cb_node, img);
2468 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002469 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002470 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002471 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002472 return skip;
2473}
2474
Jeff Leger178b1e52020-10-05 12:22:23 -04002475// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2476template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002477bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002478 const IMAGE_STATE *dst_img, const RegionType *region,
2479 const uint32_t i, const char *function,
2480 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002481 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002482 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2483 const char *vuid;
2484
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002485 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002486 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002487 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2488 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002489 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002490 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002491 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002492 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002493 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002495 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002496 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002497 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2498 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002499 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002500 const VkExtent3D dest_effective_extent =
2501 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002502 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002503 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002504 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002505 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002506 return skip;
2507}
2508
Jeff Leger178b1e52020-10-05 12:22:23 -04002509// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2510template <typename ImageCopyRegionType>
2511bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2512 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2513 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002514 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002515 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2516 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2517 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002518
2519 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002520 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002521
2522 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002523 const VkExtent3D src_copy_extent = region.extent;
2524 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002525 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2526
Dave Houlton6f9059e2017-05-02 17:15:13 -06002527 bool slice_override = false;
2528 uint32_t depth_slices = 0;
2529
2530 // Special case for copying between a 1D/2D array and a 3D image
2531 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2532 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002533 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002534 slice_override = (depth_slices != 1);
2535 } 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 -07002536 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002537 slice_override = (depth_slices != 1);
2538 }
2539
2540 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002541 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002542 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002543 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2544 skip |= LogError(src_state->image, vuid,
2545 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2546 "be 0 and 1, respectively.",
2547 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002548 }
2549 }
2550
Dave Houlton533be9f2018-03-26 17:08:30 -06002551 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 -04002552 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2553 skip |= LogError(src_state->image, vuid,
2554 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002555 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002556 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002557 }
2558
Dave Houlton533be9f2018-03-26 17:08:30 -06002559 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002560 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2561 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2562 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002563 }
2564
Dave Houltonc991cc92018-03-06 11:08:51 -07002565 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002566 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002567 if (FormatIsCompressed(src_state->createInfo.format) ||
2568 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002569 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002570 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002571 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2572 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2573 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002574 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002575 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002576 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002577 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002578 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002579 }
2580
Dave Houlton94a00372017-12-14 15:08:47 -07002581 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002582 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2583 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002584 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2585 skip |= LogError(src_state->image, vuid,
2586 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2587 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2588 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002589 }
2590
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002591 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002592 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2593 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002594 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2595 skip |= LogError(src_state->image, vuid,
2596 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2597 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2598 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002599 }
2600
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002601 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002602 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2603 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002604 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2605 skip |= LogError(src_state->image, vuid,
2606 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2607 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2608 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002609 }
2610 } // Compressed
2611
2612 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002613 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002614 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002615 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2616 skip |= LogError(dst_state->image, vuid,
2617 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002618 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002619 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002620 }
2621 }
2622
Dave Houlton533be9f2018-03-26 17:08:30 -06002623 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 -04002624 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2625 skip |= LogError(dst_state->image, vuid,
2626 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2627 "and 1, respectively.",
2628 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002629 }
2630
Dave Houlton533be9f2018-03-26 17:08:30 -06002631 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002632 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2633 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2634 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 }
2636
sfricke-samsung30b094c2020-05-30 11:42:11 -07002637 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002638 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002639 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2640 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002641 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2642 skip |= LogError(src_state->image, vuid,
2643 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2644 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2645 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002646 }
2647 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002648 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002649 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002650 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2651 skip |= LogError(dst_state->image, vuid,
2652 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2653 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2654 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002655 }
2656 }
2657 } else { // Pre maint 1
2658 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002659 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002660 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2661 skip |= LogError(src_state->image, vuid,
2662 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002663 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2664 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002665 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002666 }
Dave Houltonee281a52017-12-08 13:51:02 -07002667 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002668 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2669 skip |= LogError(dst_state->image, vuid,
2670 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002671 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2672 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002673 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002674 }
2675 }
2676 }
2677
Dave Houltonc991cc92018-03-06 11:08:51 -07002678 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2679 if (FormatIsCompressed(dst_state->createInfo.format) ||
2680 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002681 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002682
2683 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002684 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2685 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2686 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002687 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002688 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002689 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002690 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002691 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002692 }
2693
Dave Houlton94a00372017-12-14 15:08:47 -07002694 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002695 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2696 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002697 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2698 skip |= LogError(dst_state->image, vuid,
2699 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2700 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2701 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002702 }
2703
Dave Houltonee281a52017-12-08 13:51:02 -07002704 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2705 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2706 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002707 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002708 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002709 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002710 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2711 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002712 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002713 }
2714
Dave Houltonee281a52017-12-08 13:51:02 -07002715 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2716 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2717 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002718 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2719 skip |= LogError(dst_state->image, vuid,
2720 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2721 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2722 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002723 }
2724 } // Compressed
2725 }
2726 return skip;
2727}
2728
Jeff Leger178b1e52020-10-05 12:22:23 -04002729// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2730template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002731bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002732 const IMAGE_STATE *dst_image_state, const RegionType region,
2733 CopyCommandVersion version) const {
2734 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002735 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002736
Jeff Leger178b1e52020-10-05 12:22:23 -04002737 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2738 const char *vuid;
2739
Dave Houltonc991cc92018-03-06 11:08:51 -07002740 // Neither image is multiplane
2741 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2742 // If neither image is multi-plane the aspectMask member of src and dst must match
2743 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2744 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002745 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002746 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002747 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2748 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002749 }
2750 } else {
2751 // Source image multiplane checks
2752 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2753 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2754 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2755 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002756 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2757 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2758 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002759 }
2760 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2761 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2762 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002763 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2764 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2765 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002766 }
2767 // Single-plane to multi-plane
2768 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2769 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2770 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2772 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2773 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002774 }
2775
2776 // Dest image multiplane checks
2777 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2778 aspect = region.dstSubresource.aspectMask;
2779 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2780 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002781 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2782 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2783 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002784 }
2785 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2786 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2787 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002788 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2789 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2790 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002791 }
2792 // Multi-plane to single-plane
2793 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2794 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2795 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002796 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2797 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2798 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002799 }
2800 }
2801
2802 return skip;
2803}
2804
Jeff Leger178b1e52020-10-05 12:22:23 -04002805template <typename RegionType>
2806bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2807 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2808 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002809 const auto *cb_node = GetCBState(commandBuffer);
2810 const auto *src_image_state = GetImageState(srcImage);
2811 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002812 const VkFormat src_format = src_image_state->createInfo.format;
2813 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002814 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002815 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002816
Jeff Leger178b1e52020-10-05 12:22:23 -04002817 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2818 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2819 const char *vuid;
2820
2821 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002822
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002823 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2824
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002825 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002826 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002827
2828 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2829 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002830 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002831
Dave Houlton6f9059e2017-05-02 17:15:13 -06002832 bool slice_override = false;
2833 uint32_t depth_slices = 0;
2834
2835 // Special case for copying between a 1D/2D array and a 3D image
2836 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2837 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2838 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002839 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002840 slice_override = (depth_slices != 1);
2841 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2842 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002843 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002844 slice_override = (depth_slices != 1);
2845 }
2846
Jeff Leger178b1e52020-10-05 12:22:23 -04002847 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2848 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2849 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2850 skip |=
2851 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2852 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2853 skip |=
2854 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2855 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002856 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002857 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2858 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002859 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002860 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002861
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002862 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002863 // No chance of mismatch if we're overriding depth slice count
2864 if (!slice_override) {
2865 // The number of depth slices in srcSubresource and dstSubresource must match
2866 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2867 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002868 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2869 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002870 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002871 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2872 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002873 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002874 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2875 skip |= LogError(command_buffer, vuid,
2876 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002877 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002878 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002879 }
2880 }
2881 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002882 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002883 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002884 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2885 skip |= LogError(command_buffer, vuid,
2886 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2887 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002888 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002889 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002890
Dave Houltonc991cc92018-03-06 11:08:51 -07002891 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002892 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002894 }
2895
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002896 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002897 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2898 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002899 std::stringstream ss;
2900 ss << func_name << ": Src and dest aspectMasks for each region must match";
2901 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2902 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002903 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002904 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002905
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002906 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002907 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002908 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002909 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002910 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002911 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2912 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002913 }
2914
2915 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002916 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002917 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002918 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2919 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2920 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002921 }
2922
Dave Houltonfc1a4052017-04-27 14:32:45 -06002923 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002924 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2925 if (slice_override) src_copy_extent.depth = depth_slices;
2926 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002927 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002928 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2929 skip |= LogError(command_buffer, vuid,
2930 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2931 "width [%1d].",
2932 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002933 }
2934
2935 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002936 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2937 skip |= LogError(command_buffer, vuid,
2938 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2939 "height [%1d].",
2940 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002941 }
2942 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002943 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2944 skip |= LogError(command_buffer, vuid,
2945 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2946 "depth [%1d].",
2947 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002948 }
2949
Dave Houltonee281a52017-12-08 13:51:02 -07002950 // Adjust dest extent if necessary
2951 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2952 if (slice_override) dst_copy_extent.depth = depth_slices;
2953
2954 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002955 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002956 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2957 skip |= LogError(command_buffer, vuid,
2958 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002959 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002960 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002961 }
2962 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002963 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2964 skip |= LogError(command_buffer, vuid,
2965 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002966 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002967 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002968 }
2969 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002970 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
2971 skip |= LogError(command_buffer, vuid,
2972 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002973 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002974 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002975 }
2976
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002977 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2978 // must not overlap in memory
2979 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002980 for (uint32_t j = 0; j < regionCount; j++) {
2981 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002982 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002983 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002984 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
2985 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
2986 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002987 }
2988 }
2989 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08002990
2991 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
2992 if (device_extensions.vk_khr_maintenance1) {
2993 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
2994 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
2995 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002996 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
2997 skip |= LogError(command_buffer, vuid,
2998 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
2999 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003000 }
3001 } else {
3002 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3003 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3004 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003005 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3006 skip |= LogError(command_buffer, vuid,
3007 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3008 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003009 }
3010 }
3011
3012 // Check if 2D with 3D and depth not equal to 2D layerCount
3013 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3014 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3015 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003016 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3017 skip |= LogError(command_buffer, vuid,
3018 "%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 -08003019 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003020 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003021 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3022 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3023 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003024 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3025 skip |= LogError(command_buffer, vuid,
3026 "%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 -08003027 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003028 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003029 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003030
3031 // Check for multi-plane format compatiblity
3032 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3033 size_t src_format_size = 0;
3034 size_t dst_format_size = 0;
3035 if (FormatIsMultiplane(src_format)) {
3036 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3037 src_format_size = FormatElementSize(planeFormat);
3038 } else {
3039 src_format_size = FormatElementSize(src_format);
3040 }
3041 if (FormatIsMultiplane(dst_format)) {
3042 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3043 dst_format_size = FormatElementSize(planeFormat);
3044 } else {
3045 dst_format_size = FormatElementSize(dst_format);
3046 }
3047 // If size is still zero, then format is invalid and will be caught in another VU
3048 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003049 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3050 skip |= LogError(command_buffer, vuid,
3051 "%s: pRegions[%u] called with non-compatible image formats. "
3052 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3053 func_name, i, string_VkFormat(src_format),
3054 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3055 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003056 }
3057 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003058 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003059
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003060 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3061 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3062 // because because both texels are 4 bytes in size.
3063 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003064 const char *compatible_vuid =
3065 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3066 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3067 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003068 // Depth/stencil formats must match exactly.
3069 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3070 if (src_format != dst_format) {
3071 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003072 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003073 string_VkFormat(src_format), string_VkFormat(dst_format));
3074 }
3075 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003076 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003077 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003078 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003079 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003080 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003081 FormatElementSize(dst_format));
3082 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003083 }
3084 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003085
Dave Houlton33c22b72017-02-28 13:16:02 -07003086 // Source and dest image sample counts must match
3087 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003088 std::stringstream ss;
3089 ss << func_name << " called on image pair with non-identical sample counts.";
3090 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3091 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003092 }
3093
Jeff Leger178b1e52020-10-05 12:22:23 -04003094 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3095 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3096 vuid = is_2khr ? "" : "";
3097 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003098 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003099 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3100 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3101 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3102 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3103 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3104 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3105 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3106 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3107 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3108 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3109 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3110 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003111
3112 // Validation for VK_EXT_fragment_density_map
3113 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003114 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3115 skip |=
3116 LogError(command_buffer, vuid,
3117 "%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 +02003118 }
3119 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003120 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3121 skip |=
3122 LogError(command_buffer, vuid,
3123 "%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 +02003124 }
3125
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003126 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003127 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3128 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3129 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3130 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003131 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003132 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3133 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3134 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3135 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3136 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003137 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003138
3139 const char *invalid_src_layout_vuid =
3140 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3141 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3142 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3143 const char *invalid_dst_layout_vuid =
3144 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3145 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3146 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3147
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003148 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003149 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003150 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003151 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3152 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003153 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003154 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003155 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003156 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003157 }
3158
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003159 return skip;
3160}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003161
Jeff Leger178b1e52020-10-05 12:22:23 -04003162bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3163 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3164 const VkImageCopy *pRegions) const {
3165 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3166 COPY_COMMAND_VERSION_1);
3167}
3168
3169bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3170 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3171 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3172 COPY_COMMAND_VERSION_2);
3173}
3174
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003175void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3176 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3177 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003178 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3179 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003180 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003181 auto src_image_state = GetImageState(srcImage);
3182 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003183
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003184 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003185 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003186 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3187 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003188 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003189}
3190
Jeff Leger178b1e52020-10-05 12:22:23 -04003191void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3192 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3193 auto cb_node = GetCBState(commandBuffer);
3194 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3195 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3196
3197 // Make sure that all image slices are updated to correct layout
3198 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3199 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3200 pCopyImageInfo->srcImageLayout);
3201 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3202 pCopyImageInfo->dstImageLayout);
3203 }
3204}
3205
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003206// Returns true if sub_rect is entirely contained within rect
3207static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3208 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3209 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3210 return false;
3211 return true;
3212}
3213
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003214bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003215 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003216 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3217 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003218 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003219 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3220 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003221 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003222 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003223
3224 for (uint32_t j = 0; j < rect_count; j++) {
3225 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003226 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3227 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3228 "the current render pass instance.",
3229 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003230 }
3231
3232 if (image_view_state) {
3233 // The layers specified by a given element of pRects must be contained within every attachment that
3234 // pAttachments refers to
3235 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3236 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3237 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003238 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3239 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3240 "of pAttachment[%d].",
3241 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003242 }
3243 }
3244 }
3245 return skip;
3246}
3247
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003248bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3249 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003250 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003251 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003252 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003253 if (!cb_node) return skip;
3254
3255 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3256 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3257 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003258 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003259
3260 // Validate that attachment is in reference list of active subpass
3261 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003262 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003263 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003264 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003265 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003266 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003267
John Zulauf3a548ef2019-02-01 16:14:07 -07003268 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3269 auto clear_desc = &pAttachments[attachment_index];
3270 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003271 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003272
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003273 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3274 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3275 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3276 attachment_index);
3277 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3278 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3279 skip |=
3280 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3281 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3282 attachment_index);
3283 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003284 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3285 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3286 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3287 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003288 skip |= LogError(
3289 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3290 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3291 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3292 attachment_index, clear_desc->colorAttachment,
3293 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3294 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003295
John Zulauff2582972019-02-09 14:53:30 -07003296 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3297 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003298 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003299 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3300 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3301 " subpass %u. colorAttachmentCount=%u",
3302 attachment_index, clear_desc->colorAttachment,
3303 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3304 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003305 }
John Zulauff2582972019-02-09 14:53:30 -07003306 fb_attachment = color_attachment;
3307
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003308 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3309 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3310 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3311 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3312 "of a color attachment.",
3313 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003314 }
3315 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003316 bool subpass_depth = false;
3317 bool subpass_stencil = false;
3318 if (subpass_desc->pDepthStencilAttachment &&
3319 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3320 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3321 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3322 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3323 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003324 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003325 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3326 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003327 skip |= LogError(
3328 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3329 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003330 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003331 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003332 }
3333 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003334 skip |= LogError(
3335 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3336 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003337 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003338 attachment_index);
3339 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003340 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003341 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003342 }
3343 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003344 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003345 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3346 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003347 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003348
3349 // Once the framebuffer attachment is found, can get the image view state
3350 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3351 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3352 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003353 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003354 if (image_view_state != nullptr) {
3355 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3356 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3357 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3358 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3359 }
3360 }
John Zulauf441558b2019-08-12 11:47:39 -06003361 }
3362 }
3363 return skip;
3364}
3365
3366void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3367 const VkClearAttachment *pAttachments, uint32_t rectCount,
3368 const VkClearRect *pRects) {
3369 auto *cb_node = GetCBState(commandBuffer);
3370 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3371 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3372 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3373 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3374 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3375 const auto clear_desc = &pAttachments[attachment_index];
3376 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3377 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3378 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3379 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3380 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3381 subpass_desc->pDepthStencilAttachment) {
3382 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3383 }
3384 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003385 if (!clear_rect_copy) {
3386 // We need a copy of the clear rectangles that will persist until the last lambda executes
3387 // but we want to create it as lazily as possible
3388 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003389 }
John Zulauf441558b2019-08-12 11:47:39 -06003390 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3391 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003392 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003393 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003394 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003395 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3396 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003397 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003398 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003399 return skip;
3400 };
3401 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003402 }
3403 }
3404 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003405}
3406
Jeff Leger178b1e52020-10-05 12:22:23 -04003407template <typename RegionType>
3408bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3409 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3410 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003411 const auto *cb_node = GetCBState(commandBuffer);
3412 const auto *src_image_state = GetImageState(srcImage);
3413 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003414 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3415 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3416 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3417 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003418
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003419 bool skip = false;
3420 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003421 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3422 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3423 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3424 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3425 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3426 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3427 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3428 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3429 skip |= InsideRenderPass(cb_node, func_name, vuid);
3430 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3431 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3432 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3433 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3434 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3435 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3436 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3437 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003438
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003439 // Validation for VK_EXT_fragment_density_map
3440 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003441 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3442 skip |= LogError(cb_node->commandBuffer, vuid,
3443 "%s: srcImage must not have been created with flags containing "
3444 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3445 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003446 }
3447 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003448 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3449 skip |= LogError(cb_node->commandBuffer, vuid,
3450 "%s: dstImage must not have been created with flags containing "
3451 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3452 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003453 }
3454
Cort Stratton7df30962018-05-17 19:45:57 -07003455 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003456 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003457 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3458 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003459 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003460 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3461 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3462 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003463 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003464 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3465 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3466 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3467 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3468 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3469 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003470 // For each region, the number of layers in the image subresource should not be zero
3471 // For each region, src and dest image aspect must be color only
3472 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003473 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003474 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3475 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003476 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3477 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3478 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003479 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003480 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3481 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003482 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003483 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3484 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3485 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3486 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3487 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3488 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003489 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003490 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3491 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003492 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003493 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003494
3495 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003496 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003497 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3498 skip |=
3499 LogError(cb_node->commandBuffer, vuid,
3500 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003501 }
Cort Stratton7df30962018-05-17 19:45:57 -07003502 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003503 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3504 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003505 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3506 skip |= LogError(cb_node->commandBuffer, vuid,
3507 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3508 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003509 }
3510
3511 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3512 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3513
3514 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003515 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003516 LogObjectList objlist(cb_node->commandBuffer);
3517 objlist.add(src_image_state->image);
3518 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003519 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3520 skip |= LogError(objlist, vuid,
3521 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003522 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003523 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003524 }
3525 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3526 LogObjectList objlist(cb_node->commandBuffer);
3527 objlist.add(src_image_state->image);
3528 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003529 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3530 skip |= LogError(objlist, vuid,
3531 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003532 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003533 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003534 }
3535 }
3536
3537 if (VK_IMAGE_TYPE_1D == src_image_type) {
3538 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3539 LogObjectList objlist(cb_node->commandBuffer);
3540 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003541 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3542 skip |= LogError(objlist, vuid,
3543 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003544 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003545 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3546 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003547 }
3548 }
3549 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3550 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3551 LogObjectList objlist(cb_node->commandBuffer);
3552 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003553 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3554 skip |= LogError(objlist, vuid,
3555 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003556 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003557 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3558 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003559 }
3560 }
3561
3562 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3563 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3564 LogObjectList objlist(cb_node->commandBuffer);
3565 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003566 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3567 skip |= LogError(objlist, vuid,
3568 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003569 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003570 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3571 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003572 }
3573 }
3574 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3575 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3576 LogObjectList objlist(cb_node->commandBuffer);
3577 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003578 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3579 skip |= LogError(objlist, vuid,
3580 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003581 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003582 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3583 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003584 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003585 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003586
3587 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3588 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3589 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3590 // developer
3591 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3592 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3593 if ((extent_check & x_bit) != 0) {
3594 LogObjectList objlist(cb_node->commandBuffer);
3595 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003596 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3597 skip |= LogError(objlist, vuid,
3598 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003599 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003600 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003601 region.extent.width, subresource_extent.width);
3602 }
3603
3604 if ((extent_check & y_bit) != 0) {
3605 LogObjectList objlist(cb_node->commandBuffer);
3606 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003607 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3608 skip |= LogError(objlist, vuid,
3609 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003610 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003612 region.extent.height, subresource_extent.height);
3613 }
3614
3615 if ((extent_check & z_bit) != 0) {
3616 LogObjectList objlist(cb_node->commandBuffer);
3617 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003618 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3619 skip |= LogError(objlist, vuid,
3620 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003621 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003623 region.extent.depth, subresource_extent.depth);
3624 }
3625 }
3626
3627 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3628 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3629 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3630 // developer
3631 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3632 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3633 if ((extent_check & x_bit) != 0) {
3634 LogObjectList objlist(cb_node->commandBuffer);
3635 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003636 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3637 skip |= LogError(objlist, vuid,
3638 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003639 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003640 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003641 region.extent.width, subresource_extent.width);
3642 }
3643
3644 if ((extent_check & y_bit) != 0) {
3645 LogObjectList objlist(cb_node->commandBuffer);
3646 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003647 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3648 skip |= LogError(objlist, vuid,
3649 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003650 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003652 region.extent.height, subresource_extent.height);
3653 }
3654
3655 if ((extent_check & z_bit) != 0) {
3656 LogObjectList objlist(cb_node->commandBuffer);
3657 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003658 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3659 skip |= LogError(objlist, vuid,
3660 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003661 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003662 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003663 region.extent.depth, subresource_extent.depth);
3664 }
3665 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003666 }
3667
3668 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003669 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3670 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3671 func_name, string_VkFormat(src_image_state->createInfo.format),
3672 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003673 }
3674 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003675 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003676 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003677 string_VkImageType(src_image_state->createInfo.imageType),
3678 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003679 }
3680 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003681 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3682 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 -07003683 }
3684 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003685 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3686 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3687 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003688 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003689 } else {
3690 assert(0);
3691 }
3692 return skip;
3693}
3694
Jeff Leger178b1e52020-10-05 12:22:23 -04003695bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3696 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3697 const VkImageResolve *pRegions) const {
3698 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3699 COPY_COMMAND_VERSION_1);
3700}
3701
3702bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3703 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3704 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3705 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3706 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3707}
3708
3709template <typename RegionType>
3710bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3711 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3712 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003713 const auto *cb_node = GetCBState(commandBuffer);
3714 const auto *src_image_state = GetImageState(srcImage);
3715 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003716
Jeff Leger178b1e52020-10-05 12:22:23 -04003717 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3718 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3719 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3720
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003721 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003722 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003723 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003724 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003725 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003726 const char *vuid;
3727 const char *location;
3728 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3729 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3730 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3731 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3732 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3733 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3734 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3735 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3736 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3737 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3738 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3739 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3740 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3741 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3742 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3743 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3744 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3745 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3746 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3747 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3748 skip |= InsideRenderPass(cb_node, func_name, vuid);
3749 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3750 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3751 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3752 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3753 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3754 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3755 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3756 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3757 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3758 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003759
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003760 // Validation for VK_EXT_fragment_density_map
3761 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003762 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3763 skip |= LogError(cb_node->commandBuffer, vuid,
3764 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3765 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003766 }
3767 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003768 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3769 skip |= LogError(cb_node->commandBuffer, vuid,
3770 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3771 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003772 }
3773
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003774 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003775
Dave Houlton33c2d252017-06-09 17:08:32 -06003776 VkFormat src_format = src_image_state->createInfo.format;
3777 VkFormat dst_format = dst_image_state->createInfo.format;
3778 VkImageType src_type = src_image_state->createInfo.imageType;
3779 VkImageType dst_type = dst_image_state->createInfo.imageType;
3780
Cort Stratton186b1a22018-05-01 20:18:06 -04003781 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003782 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3783 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3784 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003785 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003786 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003787 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003788 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003789 }
3790
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003791 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003792 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3793 skip |= LogError(device, vuid,
3794 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003795 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003796 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003797 }
3798
3799 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003800 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3801 skip |= LogError(device, vuid,
3802 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003803 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003804 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003805 }
3806
Dave Houlton33c2d252017-06-09 17:08:32 -06003807 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003808 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3809 skip |= LogError(cb_node->commandBuffer, vuid,
3810 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003811 }
3812
Dave Houlton33c2d252017-06-09 17:08:32 -06003813 // Validate consistency for unsigned formats
3814 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3815 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003816 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003817 << "the other one must also have unsigned integer format. "
3818 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003819 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3820 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003821 }
3822
3823 // Validate consistency for signed formats
3824 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3825 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003826 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003827 << "the other one must also have signed integer format. "
3828 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003829 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3830 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003831 }
3832
3833 // Validate filter for Depth/Stencil formats
3834 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3835 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003836 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003837 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003838 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3839 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003840 }
3841
3842 // Validate aspect bits and formats for depth/stencil images
3843 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3844 if (src_format != dst_format) {
3845 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003846 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 -06003847 << "stencil, the other one must have exactly the same format. "
3848 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3849 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003850 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3851 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003852 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003853 } // Depth or Stencil
3854
3855 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003856 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003857 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3858 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3859 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3860 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3861 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3862 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003863 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003864 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3865 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3866 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3867 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3868 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3869 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003870 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003871 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003872 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003873 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003874 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003875 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3876 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003877 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003878 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3879 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3880 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3881 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3882 skip |=
3883 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3884 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3885 skip |=
3886 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3887 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003888 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003889 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3890 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003891 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003892 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003893 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003894 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3895 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003896 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003897 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003898 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003899 }
Dave Houlton48989f32017-05-26 15:01:46 -06003900 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3901 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003902 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003903 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003904 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003905 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003906
3907 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003908 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003909 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3910 skip |=
3911 LogError(cb_node->commandBuffer, vuid,
3912 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003913 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003914
Dave Houlton48989f32017-05-26 15:01:46 -06003915 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003916 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3917 skip |=
3918 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003919 }
Dave Houlton48989f32017-05-26 15:01:46 -06003920
Dave Houlton33c2d252017-06-09 17:08:32 -06003921 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003922 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3923 skip |= LogError(cb_node->commandBuffer, vuid,
3924 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003925 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003926 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003927 }
3928
3929 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003930 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3931 skip |= LogError(cb_node->commandBuffer, vuid,
3932 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3933 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003934 }
3935
Dave Houlton48989f32017-05-26 15:01:46 -06003936 // Validate source image offsets
3937 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003938 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003939 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003940 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3941 skip |= LogError(cb_node->commandBuffer, vuid,
3942 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3943 "of (%1d, %1d). These must be (0, 1).",
3944 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003945 }
3946 }
3947
Dave Houlton33c2d252017-06-09 17:08:32 -06003948 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003949 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003950 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3951 skip |= LogError(cb_node->commandBuffer, vuid,
3952 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3953 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3954 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003955 }
3956 }
3957
Dave Houlton33c2d252017-06-09 17:08:32 -06003958 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003959 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3960 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003961 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003962 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3963 skip |= LogError(cb_node->commandBuffer, vuid,
3964 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3965 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003966 }
3967 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3968 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003969 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003970 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
3971 skip |= LogError(cb_node->commandBuffer, vuid,
3972 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
3973 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003974 }
3975 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3976 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003977 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003978 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
3979 skip |= LogError(cb_node->commandBuffer, vuid,
3980 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3981 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003982 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003983 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003984 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
3985 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
3986 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003987 }
Dave Houlton48989f32017-05-26 15:01:46 -06003988
3989 // Validate dest image offsets
3990 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003991 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003992 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003993 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
3994 skip |= LogError(cb_node->commandBuffer, vuid,
3995 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3996 "(%1d, %1d). These must be (0, 1).",
3997 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003998 }
3999 }
4000
Dave Houlton33c2d252017-06-09 17:08:32 -06004001 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004002 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004003 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4004 skip |= LogError(cb_node->commandBuffer, vuid,
4005 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004006 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004007 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004008 }
4009 }
4010
Dave Houlton33c2d252017-06-09 17:08:32 -06004011 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004012 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4013 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004014 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004015 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4016 skip |= LogError(cb_node->commandBuffer, vuid,
4017 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4018 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004019 }
4020 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4021 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004022 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004023 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4024 skip |= LogError(cb_node->commandBuffer, vuid,
4025 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4026 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004027 }
4028 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4029 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004030 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004031 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4032 skip |= LogError(cb_node->commandBuffer, vuid,
4033 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4034 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004035 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004036 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004037 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4038 skip |= LogError(cb_node->commandBuffer, vuid,
4039 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004040 }
4041
Dave Houlton33c2d252017-06-09 17:08:32 -06004042 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4043 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4044 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004045 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4046 skip |= LogError(cb_node->commandBuffer, vuid,
4047 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4048 "layerCount other than 1.",
4049 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004050 }
4051 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004052 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004053 } else {
4054 assert(0);
4055 }
4056 return skip;
4057}
4058
Jeff Leger178b1e52020-10-05 12:22:23 -04004059bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4060 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4061 const VkImageBlit *pRegions, VkFilter filter) const {
4062 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4063 COPY_COMMAND_VERSION_1);
4064}
4065
4066bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4067 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4068 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4069 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4070}
4071
4072template <typename RegionType>
4073void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4074 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4075 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004076 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004077 auto src_image_state = GetImageState(srcImage);
4078 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004079
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004080 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004081 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004082 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4083 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004084 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004085}
4086
Jeff Leger178b1e52020-10-05 12:22:23 -04004087void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4088 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4089 const VkImageBlit *pRegions, VkFilter filter) {
4090 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4091 pRegions, filter);
4092 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4093}
4094
4095void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4096 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4097 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4098 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4099 pBlitImageInfo->filter);
4100}
4101
John Zulauf2076e812020-01-08 14:55:54 -07004102GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4103 assert(map);
4104 // This approach allows for a single hash lookup or/create new
4105 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4106 if (inserted.second) {
4107 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004108 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004109 inserted.first->second.reset(layout_map);
4110 return layout_map;
4111 } else {
4112 assert(nullptr != inserted.first->second.get());
4113 return inserted.first->second.get();
4114 }
4115 return nullptr;
4116}
4117
4118const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4119 auto it = map.find(image);
4120 if (it != map.end()) {
4121 return it->second.get();
4122 }
4123 return nullptr;
4124}
4125
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004126// 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 -07004127bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4128 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004129 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004130 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004131 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004132 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004133 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004134 for (const auto &layout_map_entry : pCB->image_layout_map) {
4135 const auto image = layout_map_entry.first;
4136 const auto *image_state = GetImageState(image);
4137 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004138 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004139 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004140 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004141 if (initial_layout_map.empty()) continue;
4142
4143 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4144 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4145 if (global_map == nullptr) {
4146 global_map = &empty_map;
4147 }
4148
4149 // Note: don't know if it would matter
4150 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4151
4152 auto pos = initial_layout_map.begin();
4153 const auto end = initial_layout_map.end();
4154 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4155 pos->first.begin);
4156 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004157 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004158 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004159 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 -07004160 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004161 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004162 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004163 image_layout = current_layout->pos_B->lower_bound->second;
4164 }
4165 const auto intersected_range = pos->first & current_layout->range;
4166 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4167 // TODO: Set memory invalid which is in mem_tracker currently
4168 } else if (image_layout != initial_layout) {
4169 // Need to look up the inital layout *state* to get a bit more information
4170 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4171 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4172 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4173 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004174 // We can report all the errors for the intersected range directly
4175 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004176 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004177 skip |= LogError(
4178 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004179 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004180 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004181 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004182 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004183 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004184 }
4185 }
John Zulauf2076e812020-01-08 14:55:54 -07004186 if (pos->first.includes(intersected_range.end)) {
4187 current_layout.seek(intersected_range.end);
4188 } else {
4189 ++pos;
4190 if (pos != end) {
4191 current_layout.seek(pos->first.begin);
4192 }
4193 }
John Zulauff660ad62019-03-23 07:16:05 -06004194 }
4195
locke-lunargf155ccf2020-02-18 11:34:15 -07004196 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004197 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004198 }
John Zulauff660ad62019-03-23 07:16:05 -06004199
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004200 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004201}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004202
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004203void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004204 for (const auto &layout_map_entry : pCB->image_layout_map) {
4205 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004206 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004207 const auto *image_state = GetImageState(image);
4208 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004209 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4210 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004211 }
4212}
4213
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004214// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004215// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4216// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004217bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4218 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004219 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004220 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004221 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4222
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004223 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004224 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4225 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004226 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004227 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4228 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4229 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004230 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004231 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004232 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004233 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4234 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4235 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004236 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004237 string_VkImageLayout(first_layout));
4238 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4239 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004240 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004241 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004242 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004243 }
4244 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004245
4246 // Same as above for loadOp, but for stencilLoadOp
4247 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4248 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4249 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4250 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4251 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004252 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004253 string_VkImageLayout(first_layout));
4254 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4255 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4256 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004257 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004258 string_VkImageLayout(first_layout));
4259 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4260 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4261 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004262 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004263 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004264 }
4265 }
4266
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004267 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004268}
4269
Mark Lobodzinski96210742017-02-09 10:33:46 -07004270// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4271// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004272template <typename T1>
4273bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4274 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4275 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004276 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004277 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004278 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004279 if (strict) {
4280 correct_usage = ((actual & desired) == desired);
4281 } else {
4282 correct_usage = ((actual & desired) != 0);
4283 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004284
Mark Lobodzinski96210742017-02-09 10:33:46 -07004285 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004286 // All callers should have a valid VUID
4287 assert(msgCode != kVUIDUndefined);
4288 skip =
4289 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4290 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004291 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004292 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004293}
4294
4295// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4296// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004297bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004298 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004299 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004300 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004301}
4302
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004303bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004304 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004305 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004306 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4307 if ((image_format_features & desired) != desired) {
4308 // Same error, but more details if it was an AHB external format
4309 if (image_state->has_ahb_format == true) {
4310 skip |= LogError(image_state->image, vuid,
4311 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4312 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4313 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004314 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004315 } else {
4316 skip |= LogError(image_state->image, vuid,
4317 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4318 "with tiling %s.",
4319 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4320 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4321 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004322 }
4323 }
4324 return skip;
4325}
4326
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004327bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004328 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004329 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004330 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004331 // layerCount must not be zero
4332 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004333 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4334 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004335 }
4336 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004337 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004338 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4339 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004340 }
4341 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004342 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 -07004343 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4344 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4345 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4346 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004347 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004348 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4349 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4350 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4351 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4352 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4353 member);
4354 }
Cort Strattond619a302018-05-17 19:46:32 -07004355 return skip;
4356}
4357
Mark Lobodzinski96210742017-02-09 10:33:46 -07004358// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4359// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004360bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004361 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004362 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004363 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004364}
4365
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004366bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004367 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004368 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004369
4370 const VkDeviceSize &range = pCreateInfo->range;
4371 if (range != VK_WHOLE_SIZE) {
4372 // Range must be greater than 0
4373 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004374 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004375 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004376 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4377 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004378 }
4379 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004380 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4381 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004382 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004383 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004384 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4385 "(%" PRIu32 ").",
4386 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004387 }
4388 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004389 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004390 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004391 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004392 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4393 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4394 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004395 }
4396 // The sum of range and offset must be less than or equal to the size of buffer
4397 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004398 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004399 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004400 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4401 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4402 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004403 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004404 } else {
4405 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4406
4407 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4408 // VkPhysicalDeviceLimits::maxTexelBufferElements
4409 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4410 device_limits->maxTexelBufferElements) {
4411 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4412 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4413 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4414 "), divided by the element size of the format (%" PRIu32
4415 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4416 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4417 device_limits->maxTexelBufferElements);
4418 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004419 }
4420 return skip;
4421}
4422
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004423bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004424 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004425 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004426 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4427 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004428 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004429 "vkCreateBufferView(): If buffer was created with `usage` containing "
4430 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004431 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004432 }
4433 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4434 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004435 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004436 "vkCreateBufferView(): If buffer was created with `usage` containing "
4437 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004438 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004439 }
4440 return skip;
4441}
4442
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004443bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004444 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004445 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004446
Dave Houltond8ed0212018-05-16 17:18:24 -06004447 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004448
Jeff Bolz87697532019-01-11 22:54:00 -06004449 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4450 if (chained_devaddr_struct) {
4451 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4452 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004453 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4454 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4455 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004456 }
4457 }
4458
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004459 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4460 if (chained_opaqueaddr_struct) {
4461 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4462 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004463 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4464 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4465 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004466 }
4467 }
4468
Shannon McPherson4984e642019-12-05 13:04:34 -07004469 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004470 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4471 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004472 skip |= LogError(
4473 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004474 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4475 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4476 }
4477
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004478 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004479 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4480 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4481 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004482 }
4483
sfricke-samsungedce77a2020-07-03 22:35:13 -07004484 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4485 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4486 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4487 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4488 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4489 }
4490 const VkBufferCreateFlags invalid_flags =
4491 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4492 if ((pCreateInfo->flags & invalid_flags) != 0) {
4493 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4494 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4495 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4496 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4497 }
4498 }
4499
Mark Lobodzinski96210742017-02-09 10:33:46 -07004500 return skip;
4501}
4502
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004503bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004504 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004505 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004506 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004507 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4508 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004509 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004510 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4511 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004512 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004513 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4514 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4515 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004516
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004517 // Buffer view offset must be less than the size of buffer
4518 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004519 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004520 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004521 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4522 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004523 }
4524
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004525 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004526 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4527 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4528 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004529 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4530 : "VUID-VkBufferViewCreateInfo-offset-00926";
4531 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004532 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004533 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4534 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004535 }
4536
4537 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4538 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4539 if ((elementSize % 3) == 0) {
4540 elementSize /= 3;
4541 }
4542 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4543 VkDeviceSize alignmentRequirement =
4544 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4545 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4546 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4547 }
4548 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004549 skip |= LogError(
4550 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004551 "vkCreateBufferView(): If buffer was created with usage containing "
4552 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004553 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4554 ") must be a multiple of the lesser of "
4555 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4556 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4557 "(%" PRId32
4558 ") is VK_TRUE, the size of a texel of the requested format. "
4559 "If the size of a texel is a multiple of three bytes, then the size of a "
4560 "single component of format is used instead",
4561 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4562 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4563 }
4564 }
4565 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4566 VkDeviceSize alignmentRequirement =
4567 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4568 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4569 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4570 }
4571 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004572 skip |= LogError(
4573 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004574 "vkCreateBufferView(): If buffer was created with usage containing "
4575 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004576 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4577 ") must be a multiple of the lesser of "
4578 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4579 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4580 "(%" PRId32
4581 ") is VK_TRUE, the size of a texel of the requested format. "
4582 "If the size of a texel is a multiple of three bytes, then the size of a "
4583 "single component of format is used instead",
4584 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4585 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4586 }
4587 }
4588 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004589
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004590 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004591
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004592 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004593 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004594 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004595}
4596
Mark Lobodzinski602de982017-02-09 11:01:33 -07004597// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004598bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004599 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004600 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004601 const IMAGE_STATE *image_state = GetImageState(image);
4602 // checks color format and (single-plane or non-disjoint)
4603 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004604 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004605 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004606 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 -07004607 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004608 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 -07004609 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004610 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004611 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004612 skip |= LogError(image, vuid,
4613 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4614 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4615 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004616 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004617 skip |= LogError(image, vuid,
4618 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4619 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4620 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004621 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004622 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004623 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004624 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 -07004625 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004626 skip |=
4627 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 -07004628 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004629 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004630 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004631 skip |=
4632 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 -07004633 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004634 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4635 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004636 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004637 } else if (FormatIsMultiplane(format)) {
4638 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4639 if (3 == FormatPlaneCount(format)) {
4640 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4641 }
4642 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004643 skip |=
4644 LogError(image, vuid,
4645 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4646 "set, where n = [0, 1, 2].",
4647 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004648 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004649 }
4650 return skip;
4651}
4652
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004653bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4654 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004655 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4656 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004657 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004658
4659 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004660 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004661 skip |= LogError(image, errorCodes.base_mip_err,
4662 "%s: %s.baseMipLevel (= %" PRIu32
4663 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4664 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004665 }
Petr Kraus4d718682017-05-18 03:38:41 +02004666
Petr Krausffa94af2017-08-08 21:46:02 +02004667 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4668 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004669 skip |=
4670 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004671 } else {
4672 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004673
Petr Krausffa94af2017-08-08 21:46:02 +02004674 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004675 skip |= LogError(image, errorCodes.mip_count_err,
4676 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4677 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4678 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4679 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004680 }
Petr Kraus4d718682017-05-18 03:38:41 +02004681 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004682 }
Petr Kraus4d718682017-05-18 03:38:41 +02004683
4684 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004685 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004686 skip |= LogError(image, errorCodes.base_layer_err,
4687 "%s: %s.baseArrayLayer (= %" PRIu32
4688 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4689 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004690 }
Petr Kraus4d718682017-05-18 03:38:41 +02004691
Petr Krausffa94af2017-08-08 21:46:02 +02004692 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4693 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004694 skip |=
4695 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004696 } else {
4697 const uint64_t necessary_layer_count =
4698 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004699
Petr Krausffa94af2017-08-08 21:46:02 +02004700 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004701 skip |= LogError(image, errorCodes.layer_count_err,
4702 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4703 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4704 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4705 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004706 }
Petr Kraus4d718682017-05-18 03:38:41 +02004707 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004708 }
Petr Kraus4d718682017-05-18 03:38:41 +02004709
Mark Lobodzinski602de982017-02-09 11:01:33 -07004710 return skip;
4711}
4712
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004713bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004714 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004715 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004716 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4717 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4718 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4719
4720 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4721 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4722
4723 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004724 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4725 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004726 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004727 : "VUID-VkImageViewCreateInfo-image-01482")
4728 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4729 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004730 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004731 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4732 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004733
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004734 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004735 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004736 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004737}
4738
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004739bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004740 const VkImageSubresourceRange &subresourceRange,
4741 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004742 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004743 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4744 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4745 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4746 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004747
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004748 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004749 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004750 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004751}
4752
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004753bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004754 const VkImageSubresourceRange &subresourceRange,
4755 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004756 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004757 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4758 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4759 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4760 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004761
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004762 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004763 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4764 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004765}
4766
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004767bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004768 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004769 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004770 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004771 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4772 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4773 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4774 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004775
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004776 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004777 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004778}
4779
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004780bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4781 const VkImageUsageFlags image_usage) const {
4782 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4783 bool skip = false;
4784
4785 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4786 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4787
4788 if (image_state->has_ahb_format == true) {
4789 // AHB image view and image share same feature sets
4790 tiling_features = image_state->format_features;
4791 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4792 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4793 assert(device_extensions.vk_ext_image_drm_format_modifier);
4794 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4795 nullptr};
4796 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4797
4798 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4799 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4800 nullptr};
4801 format_properties_2.pNext = (void *)&drm_properties_list;
4802 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4803
4804 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4805 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4806 0) {
4807 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4808 }
4809 }
4810 } else {
4811 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4812 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4813 : format_properties.optimalTilingFeatures;
4814 }
4815
4816 if (tiling_features == 0) {
4817 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4818 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4819 "physical device.",
4820 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4821 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4822 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4823 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4824 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4825 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4826 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4827 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4828 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4829 "VK_IMAGE_USAGE_STORAGE_BIT.",
4830 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4831 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4832 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4833 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4834 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4835 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4836 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4837 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4838 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4839 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4840 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4841 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4842 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4843 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4844 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4845 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4846 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4847 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4848 }
4849
4850 return skip;
4851}
4852
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004853bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004854 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004855 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004856 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004857 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004858 skip |=
4859 ValidateImageUsageFlags(image_state,
4860 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4861 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004862 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4863 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4864 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004865 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004866 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004867 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004868 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004869 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004870 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004871 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004872 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004873
4874 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4875 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004876 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004877 VkFormat view_format = pCreateInfo->format;
4878 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004879 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004880 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004881
Dave Houltonbd2e2622018-04-10 16:41:14 -06004882 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004883 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004884 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004885 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004886 if (!device_extensions.vk_ext_separate_stencil_usage) {
4887 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004888 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4889 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4890 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004891 }
4892 } else {
4893 const auto image_stencil_struct =
4894 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4895 if (image_stencil_struct == nullptr) {
4896 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004897 skip |= LogError(
4898 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004899 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4900 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4901 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4902 }
4903 } else {
4904 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4905 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4906 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004907 skip |= LogError(
4908 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004909 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4910 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4911 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4912 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4913 }
4914 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4915 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004916 skip |= LogError(
4917 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004918 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4919 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4920 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4921 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4922 }
4923 }
4924 }
4925 }
4926
Dave Houltonbd2e2622018-04-10 16:41:14 -06004927 image_usage = chained_ivuci_struct->usage;
4928 }
4929
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004930 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4931 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004932 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004933 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004934 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004935 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004936 std::stringstream ss;
4937 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004938 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004939 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004940 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004941 }
4942 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004943 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004944 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4945 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004946 const char *error_vuid;
4947 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4948 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4949 } else if ((device_extensions.vk_khr_maintenance2) &&
4950 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4951 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4952 } else if ((!device_extensions.vk_khr_maintenance2) &&
4953 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4954 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4955 } else {
4956 // both enabled
4957 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4958 }
Dave Houltonc7988072018-04-16 11:46:56 -06004959 std::stringstream ss;
4960 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004961 << " is not in the same format compatibility class as "
4962 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004963 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4964 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004965 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004966 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004967 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004968 }
4969 } else {
4970 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004971 // Unless it is a multi-planar color bit aspect
4972 if ((image_format != view_format) &&
4973 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4974 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4975 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004976 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004977 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004978 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004979 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004980 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004981 }
4982 }
4983
4984 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004985 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004986
4987 switch (image_type) {
4988 case VK_IMAGE_TYPE_1D:
4989 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004990 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
4991 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4992 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004993 }
4994 break;
4995 case VK_IMAGE_TYPE_2D:
4996 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4997 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4998 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004999 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
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 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005003 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5004 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5005 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005006 }
5007 }
5008 break;
5009 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005010 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005011 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5012 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5013 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005014 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005015 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5016 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5017 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005018 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5019 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005020 skip |= LogError(
5021 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5022 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5023 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5024 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5025 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005026 }
5027 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005028 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5029 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5030 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005031 }
5032 }
5033 } else {
5034 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005035 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5036 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5037 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005038 }
5039 }
5040 break;
5041 default:
5042 break;
5043 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005044
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005045 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005046 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005047 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005048 }
5049
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005050 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005051
Jeff Bolz9af91c52018-09-01 21:53:57 -05005052 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5053 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005054 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5055 "vkCreateImageView() If image was created with usage containing "
5056 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5057 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005058 }
5059 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005060 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5061 "vkCreateImageView() If image was created with usage containing "
5062 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005063 }
5064 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005065
5066 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5067 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5068 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5069 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5070 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5071 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5072 }
5073 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5074 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5075 skip |= LogError(
5076 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5077 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5078 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5079 }
5080 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005081
5082 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5083 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005084 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005085 "vkCreateImageView(): If image was created with usage containing "
5086 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5087 pCreateInfo->subresourceRange.levelCount);
5088 }
5089 }
5090 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5091 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005092 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005093 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5094 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5095 }
5096 } else {
5097 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5098 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5099 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005100 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005101 "vkCreateImageView(): If image was created with usage containing "
5102 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5103 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5104 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5105 }
5106 }
5107 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005108
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005109 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5110 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5111 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5112 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5113 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5114 }
5115 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5116 skip |=
5117 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5118 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5119 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5120 }
5121 }
5122 if (device_extensions.vk_ext_fragment_density_map_2) {
5123 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5124 (pCreateInfo->subresourceRange.layerCount >
5125 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5126 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5127 "vkCreateImageView(): If image was created with flags containing "
5128 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5129 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5130 pCreateInfo->subresourceRange.layerCount,
5131 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5132 }
5133 }
5134
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005135 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5136 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5137 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5138 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5139 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5140 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5141 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5142 }
5143 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005144 }
5145 return skip;
5146}
5147
Jeff Leger178b1e52020-10-05 12:22:23 -04005148template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005149bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005150 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005151 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005152 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5153 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5154 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005155
5156 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5157 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5158 VkDeviceSize src_min = UINT64_MAX;
5159 VkDeviceSize src_max = 0;
5160 VkDeviceSize dst_min = UINT64_MAX;
5161 VkDeviceSize dst_max = 0;
5162
5163 for (uint32_t i = 0; i < regionCount; i++) {
5164 src_min = std::min(src_min, pRegions[i].srcOffset);
5165 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5166 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5167 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5168
5169 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5170 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005171 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5172 skip |= LogError(src_buffer_state->buffer, vuid,
5173 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5174 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005175 }
5176
5177 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5178 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005179 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5180 skip |= LogError(dst_buffer_state->buffer, vuid,
5181 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5182 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005183 }
5184
5185 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5186 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005187 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5188 skip |= LogError(src_buffer_state->buffer, vuid,
5189 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005190 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005191 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005192 }
5193
5194 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5195 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005196 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5197 skip |= LogError(dst_buffer_state->buffer, vuid,
5198 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005199 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005200 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005201 }
5202 }
5203
5204 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5205 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5206 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005207 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5208 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5209 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005210 }
5211 }
5212
5213 return skip;
5214}
5215
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005216bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005217 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005218 const auto cb_node = GetCBState(commandBuffer);
5219 const auto src_buffer_state = GetBufferState(srcBuffer);
5220 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005221
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005222 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005223 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5224 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005225 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005226 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005227 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5228 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005229 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005230 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5231 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005232 skip |=
5233 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5234 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005235 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5236 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005237 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005238 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5239 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5240 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005241 return skip;
5242}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005243
Jeff Leger178b1e52020-10-05 12:22:23 -04005244bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5245 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5246 const auto cb_node = GetCBState(commandBuffer);
5247 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5248 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5249
5250 bool skip = false;
5251 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5252 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5253 // Validate that SRC & DST buffers have correct usage flags set
5254 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5255 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5256 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5257 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5258 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5259 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5260 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5261 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5262 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5263 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5264 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5265 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5266 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5267 skip |=
5268 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5269 skip |=
5270 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5271 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5272 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5273 return skip;
5274}
5275
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005276bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005277 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005278 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005279 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005280 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005281 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5282 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005283 }
5284 }
5285 return skip;
5286}
5287
Jeff Bolz5c801d12019-10-09 10:38:45 -05005288bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5289 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005290 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005291 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005292
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005293 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005294 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005295 skip |=
5296 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005297 }
5298 return skip;
5299}
5300
Jeff Bolz5c801d12019-10-09 10:38:45 -05005301bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005302 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005303
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005304 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005305 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005306 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005307 }
5308 return skip;
5309}
5310
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005311bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005312 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005313 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005314 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005315 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005316 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005317 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005318 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005319 }
5320 return skip;
5321}
5322
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005323bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005324 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005325 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005326 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005327 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005328 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005329 skip |=
5330 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5331 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005332 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005333 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005334 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5335 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005336 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005337
sfricke-samsung022fa252020-07-24 03:26:16 -07005338 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5339 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5340
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005341 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005342 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5343 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5344 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5345 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005346 }
5347
5348 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005349 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5350 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5351 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5352 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005353 }
5354
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005355 return skip;
5356}
5357
Jeff Leger178b1e52020-10-05 12:22:23 -04005358template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005359bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005360 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005361 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005362 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005363 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5364 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005365
sfricke-samsung125d2b42020-05-28 06:32:43 -07005366 assert(image_state != nullptr);
5367 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005368
5369 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005370 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005371 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5372 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005373 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005374 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5375 "and 1, respectively.",
5376 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005377 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005378 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005379
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005380 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5381 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005382 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005383 "%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 -07005384 "must be 0 and 1, respectively.",
5385 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005386 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005387 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005388
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005389 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5390 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005391 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005392 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005393 "For 3D images these must be 0 and 1, respectively.",
5394 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005395 }
5396 }
5397
5398 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005399 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005400 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005401
sfricke-samsung125d2b42020-05-28 06:32:43 -07005402 // If not depth/stencil and not multi-plane
5403 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5404 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005405 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5406 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5407 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005408 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005409 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005410 " must be a multiple of this format's texel size (%" PRIu32 ").",
5411 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005412 }
5413
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005414 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5415 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005416 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005417 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005418 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005419 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005420 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005421 }
5422
5423 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5424 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005425 vuid =
5426 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005427 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005428 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005429 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5430 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005431 }
5432
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005433 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005434 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005435 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005436 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 -06005437 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5438 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005439 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005440 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005441 "zero or <= image subresource width (%d).",
5442 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005443 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005444 }
5445
5446 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005447 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 -06005448 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5449 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005450 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005451 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005452 "zero or <= image subresource height (%d).",
5453 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005454 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005455 }
5456
5457 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005458 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 -06005459 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5460 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005461 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005462 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005463 "zero or <= image subresource depth (%d).",
5464 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005465 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005466 }
5467
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005468 // subresource aspectMask must have exactly 1 bit set
5469 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005470 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005471 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005472 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5473 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005474 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005475 }
5476
5477 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005478 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005479 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005480 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005481 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5482 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005483 }
5484
5485 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005486 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5487 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005488
5489 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005490 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005491 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005492 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005493 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5494 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005495 }
5496
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005497 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005498 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005499 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005500 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005501 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005502 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005503 }
5504
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005505 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005506 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5507 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5508 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005509 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005510 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005511 "width & height (%d, %d)..",
5512 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5513 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005514 }
5515
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005516 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005517 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005518 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005519 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005520 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005521 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5522 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005523 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005524
5525 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005526 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005527 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005528 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005529 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005530 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005531 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5532 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5533 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005534 }
5535
5536 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005537 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005538 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005539 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005540 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005541 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5542 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5543 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005544 }
5545
5546 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005547 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005548 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005549 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005550 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005551 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5552 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5553 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005554 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005555 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005556
5557 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005558 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005559 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005560 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005561 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005562 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005563 "format has three planes.",
5564 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005565 }
5566
5567 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005568 if (0 ==
5569 (region_aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005570 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005571 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005572 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5573 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005574 } else {
5575 // Know aspect mask is valid
5576 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5577 const uint32_t compatible_size = FormatElementSize(compatible_format);
5578 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5579 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005580 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005581 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005582 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5583 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5584 string_VkFormat(compatible_format));
5585 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005586 }
5587 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005588 }
5589
5590 return skip;
5591}
5592
Jeff Leger178b1e52020-10-05 12:22:23 -04005593template <typename BufferImageCopyRegionType>
5594bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5595 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005596 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005597 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005598
5599 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005600 VkExtent3D extent = pRegions[i].imageExtent;
5601 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005602
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005603 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5604 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005605 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5606 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5607 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005608 }
5609
5610 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5611
5612 // 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 -06005613 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005614 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005615 if (image_extent.width % block_extent.width) {
5616 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5617 }
5618 if (image_extent.height % block_extent.height) {
5619 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5620 }
5621 if (image_extent.depth % block_extent.depth) {
5622 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5623 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005624 }
5625
Dave Houltonfc1a4052017-04-27 14:32:45 -06005626 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005627 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005628 }
5629 }
5630
5631 return skip;
5632}
5633
Jeff Leger178b1e52020-10-05 12:22:23 -04005634template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005635bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005636 const BufferImageCopyRegionType *pRegions, const char *func_name,
5637 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005638 bool skip = false;
5639
5640 VkDeviceSize buffer_size = buff_state->createInfo.size;
5641
5642 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005643 VkDeviceSize max_buffer_offset =
5644 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5645 if (buffer_size < max_buffer_offset) {
5646 skip |=
5647 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 -07005648 }
5649 }
5650
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005651 return skip;
5652}
5653
Jeff Leger178b1e52020-10-05 12:22:23 -04005654template <typename BufferImageCopyRegionType>
5655bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5656 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5657 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005658 const auto cb_node = GetCBState(commandBuffer);
5659 const auto src_image_state = GetImageState(srcImage);
5660 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005661
Jeff Leger178b1e52020-10-05 12:22:23 -04005662 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5663 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5664 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5665 const char *vuid;
5666
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005667 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005668
5669 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005670 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005671
5672 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005673 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005674
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005675 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005676
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005677 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005678 vuid =
5679 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5680 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5681 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5682 "or transfer capabilities.",
5683 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005684 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005685 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5686 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5687 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5688 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005689
Jeff Leger178b1e52020-10-05 12:22:23 -04005690 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5691 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5692 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5693
5694 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5695 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5696 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5697 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005698
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005699 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005700 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5701 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005702 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005703 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5704 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005705 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005706 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5707 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5708 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5709 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5710 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5711 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005712
5713 // Validation for VK_EXT_fragment_density_map
5714 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005715 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5716 skip |= LogError(cb_node->commandBuffer, vuid,
5717 "%s: srcImage must not have been created with flags containing "
5718 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5719 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005720 }
5721
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005722 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005723 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5724 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005725 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005726 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5727 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005728 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005729
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005730 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 -04005731 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5732 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5733 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5734 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5735
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005736 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005737 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5738 vuid =
5739 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005740 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005741 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5742 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5743 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5744 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5745 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5746 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5747 "imageSubresource", vuid);
5748 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5749 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005750 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005751 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005752 }
5753 return skip;
5754}
5755
Jeff Leger178b1e52020-10-05 12:22:23 -04005756bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5757 VkBuffer dstBuffer, uint32_t regionCount,
5758 const VkBufferImageCopy *pRegions) const {
5759 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5760 COPY_COMMAND_VERSION_1);
5761}
5762
5763bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5764 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5765 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5766 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5767 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5768}
5769
John Zulauf1686f232019-07-09 16:27:11 -06005770void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5771 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5772 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5773
5774 auto cb_node = GetCBState(commandBuffer);
5775 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005776 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005777 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005778 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005779 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005780}
5781
Jeff Leger178b1e52020-10-05 12:22:23 -04005782void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5783 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5784 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5785
5786 auto cb_node = GetCBState(commandBuffer);
5787 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5788 // Make sure that all image slices record referenced layout
5789 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5790 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5791 pCopyImageToBufferInfo->srcImageLayout);
5792 }
5793}
5794
5795template <typename RegionType>
5796bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5797 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5798 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005799 const auto cb_node = GetCBState(commandBuffer);
5800 const auto src_buffer_state = GetBufferState(srcBuffer);
5801 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005802
Jeff Leger178b1e52020-10-05 12:22:23 -04005803 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5804 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5805 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5806 const char *vuid;
5807
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005808 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005809
5810 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005811 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005812
sfricke-samsungea4fd142020-10-17 23:51:59 -07005813 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5814 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5815
Jeff Leger178b1e52020-10-05 12:22:23 -04005816 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5817 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5818 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5819 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5820
5821 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5822 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5823 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5824 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5825 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5826 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5827 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5828 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5829 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005830 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005831 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5832 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005833 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005834 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5835 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5836 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5837 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5838 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5839 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005840
5841 // Validation for VK_EXT_fragment_density_map
5842 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005843 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5844 skip |= LogError(cb_node->commandBuffer, vuid,
5845 "%s: dstImage must not have been created with flags containing "
5846 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5847 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005848 }
5849
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005850 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005851 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5852 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005853 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005854 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5855 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005856 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005857
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005858 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 -04005859 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5860 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5861 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5862 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5863
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005864 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005865 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5866 vuid =
5867 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005868 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005869 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5870 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5871 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5872 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5873 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5874 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5875 "imageSubresource", vuid);
5876 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5877 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005878 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005879 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005880
5881 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5882 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5883 assert(command_pool != nullptr);
5884 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5885 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5886 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5887 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5888 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5889 LogObjectList objlist(cb_node->commandBuffer);
5890 objlist.add(command_pool->commandPool);
5891 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5892 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5893 skip |= LogError(dst_image_state->image, vuid,
5894 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5895 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5896 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5897 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5898 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5899 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005900 }
5901 return skip;
5902}
5903
Jeff Leger178b1e52020-10-05 12:22:23 -04005904bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5905 VkImageLayout dstImageLayout, uint32_t regionCount,
5906 const VkBufferImageCopy *pRegions) const {
5907 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
5908 COPY_COMMAND_VERSION_1);
5909}
5910
5911bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5912 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
5913 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
5914 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
5915 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
5916}
5917
John Zulauf1686f232019-07-09 16:27:11 -06005918void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5919 VkImageLayout dstImageLayout, uint32_t regionCount,
5920 const VkBufferImageCopy *pRegions) {
5921 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5922
5923 auto cb_node = GetCBState(commandBuffer);
5924 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005925 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005926 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005927 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005928 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005929}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005930
Jeff Leger178b1e52020-10-05 12:22:23 -04005931void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5932 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
5933 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
5934
5935 auto cb_node = GetCBState(commandBuffer);
5936 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
5937 // Make sure that all image slices are record referenced layout
5938 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
5939 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
5940 pCopyBufferToImageInfo2KHR->dstImageLayout);
5941 }
5942}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005943bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005944 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005945 bool skip = false;
5946 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5947
Dave Houlton1d960ff2018-01-19 12:17:05 -07005948 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005949 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5950 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5951 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005952 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5953 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005954 }
5955
John Zulaufa26d3c82019-08-14 16:09:08 -06005956 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005957 if (!image_entry) {
5958 return skip;
5959 }
5960
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005961 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5962 if (device_extensions.vk_ext_image_drm_format_modifier) {
5963 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5964 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005965 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5966 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5967 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005968 }
5969 } else {
5970 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005971 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5972 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005973 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005974 }
5975
Dave Houlton1d960ff2018-01-19 12:17:05 -07005976 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005977 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005978 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5979 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5980 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005981 }
5982
Dave Houlton1d960ff2018-01-19 12:17:05 -07005983 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005984 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005985 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5986 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5987 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005988 }
5989
Dave Houlton1d960ff2018-01-19 12:17:05 -07005990 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005991 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005992 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5993 if (FormatIsMultiplane(img_format)) {
5994 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5995 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5996 if (FormatPlaneCount(img_format) > 2u) {
5997 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5998 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5999 }
6000 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006001 skip |= LogError(image, vuid,
6002 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6003 ") must be a single-plane specifier flag.",
6004 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006005 }
6006 } else if (FormatIsColor(img_format)) {
6007 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006008 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6009 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6010 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006011 }
6012 } else if (FormatIsDepthOrStencil(img_format)) {
6013 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6014 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006015 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006016 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6017 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6018 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6019 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006020 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6021 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6022 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006023 }
6024 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006025
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006026 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006027 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006028 }
6029
Mike Weiblen672b58b2017-02-21 14:32:53 -07006030 return skip;
6031}
sfricke-samsung022fa252020-07-24 03:26:16 -07006032
6033// Validates the image is allowed to be protected
6034bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006035 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006036 bool skip = false;
6037 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6038 LogObjectList objlist(cb_state->commandBuffer);
6039 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006040 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while image %s is a protected image.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006041 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006042 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006043 }
6044 return skip;
6045}
6046
6047// Validates the image is allowed to be unprotected
6048bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006049 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006050 bool skip = false;
6051 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6052 LogObjectList objlist(cb_state->commandBuffer);
6053 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006054 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while image %s is an unprotected image.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006055 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006056 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006057 }
6058 return skip;
6059}
6060
6061// Validates the buffer is allowed to be protected
6062bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006063 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006064 bool skip = false;
6065 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6066 LogObjectList objlist(cb_state->commandBuffer);
6067 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006068 skip |= LogError(objlist, vuid, "%s: command buffer %s is unprotected while buffer %s is a protected buffer.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006069 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006070 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006071 }
6072 return skip;
6073}
6074
6075// Validates the buffer is allowed to be unprotected
6076bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006077 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006078 bool skip = false;
6079 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6080 LogObjectList objlist(cb_state->commandBuffer);
6081 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006082 skip |= LogError(objlist, vuid, "%s: command buffer %s is protected while buffer %s is an unprotected buffer.%s", cmd_name,
sfricke-samsung022fa252020-07-24 03:26:16 -07006083 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006084 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006085 }
6086 return skip;
6087}