blob: 4b3ab89869add91b90fbf79d607c1cfb46d4e1dc [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
Nathaniel Cesarioc02c2512020-11-13 12:04:24 -07001957 // Check compatibility with VK_KHR_portability_subset
1958 if (ExtEnabled::kNotEnabled != device_extensions.vk_khr_portability_subset) {
1959 if (VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT & pCreateInfo->flags &&
1960 VK_FALSE == enabled_features.portability_subset_features.imageView2DOn3DImage) {
1961 skip |= LogError(device, "VUID-VkImageCreateInfo-imageView2DOn3DImage-04459",
1962 "vkCreateImage (portability error): VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT is not supported.");
1963 }
1964 if ((VK_SAMPLE_COUNT_1_BIT != pCreateInfo->samples) && (1 != pCreateInfo->arrayLayers) &&
1965 (VK_FALSE == enabled_features.portability_subset_features.multisampleArrayImage)) {
1966 skip |=
1967 LogError(device, "VUID-VkImageCreateInfo-multisampleArrayImage-04460",
1968 "vkCreateImage (portability error): Cannot create an image with samples/texel > 1 && arrayLayers != 1");
1969 }
1970 }
1971
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001972 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001973}
1974
John Zulauf7eeb6f72019-06-17 11:56:36 -06001975void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1976 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1977 if (VK_SUCCESS != result) return;
1978
1979 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
locke-lunarg20699892020-01-02 19:17:29 -07001980 auto image_state = Get<IMAGE_STATE>(*pImage);
1981 AddInitialLayoutintoImageLayoutMap(*image_state, imageLayoutMap);
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001982}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001983
Jeff Bolz5c801d12019-10-09 10:38:45 -05001984bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001985 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001986 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001987 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001988 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001989 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001990 }
1991 return skip;
1992}
1993
John Zulauf7eeb6f72019-06-17 11:56:36 -06001994void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1995 // Clean up validation specific data
1996 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001997
locke-lunargcba7d5f2019-12-30 16:59:11 -07001998 imageLayoutMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001999
2000 // Clean up generic image state
2001 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07002002}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002003
sfricke-samsungcd924d92020-05-20 23:51:17 -07002004bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
2005 const char *param_name) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002006 bool skip = false;
sfricke-samsungcd924d92020-05-20 23:51:17 -07002007 const VkImage image = image_state->image;
2008 const VkFormat format = image_state->createInfo.format;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002009
2010 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002011 skip |= LogError(image, "VUID-vkCmdClearColorImage-aspectMask-02498",
2012 "vkCmdClearColorImage(): %s.aspectMasks must only be set to VK_IMAGE_ASPECT_COLOR_BIT.", param_name);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002013 }
2014
sfricke-samsungcd924d92020-05-20 23:51:17 -07002015 if (FormatIsDepthOrStencil(format)) {
2016 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2017 "vkCmdClearColorImage(): %s called with image %s which has a depth/stencil format (%s).", param_name,
2018 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
2019 } else if (FormatIsCompressed(format)) {
2020 skip |= LogError(image, "VUID-vkCmdClearColorImage-image-00007",
2021 "vkCmdClearColorImage(): %s called with image %s which has a compressed format (%s).", param_name,
2022 report_data->FormatHandle(image).c_str(), string_VkFormat(format));
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002023 }
2024
2025 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002026 skip |=
2027 LogError(image, "VUID-vkCmdClearColorImage-image-00002",
2028 "vkCmdClearColorImage() %s called with image %s which was created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.",
2029 param_name, report_data->FormatHandle(image).c_str());
Mark Lobodzinskic409a582017-01-27 15:16:01 -07002030 }
2031 return skip;
2032}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002033
John Zulauf07288512019-07-05 11:09:50 -06002034bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
2035 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
2036 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002037 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002038 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2039 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002040 skip |= LogError(image_state->image, "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
2041 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2042 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002043 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002044
2045 } else {
2046 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
2047 if (!device_extensions.vk_khr_shared_presentable_image) {
2048 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002049 skip |= LogError(image_state->image, "VUID-vkCmdClearColorImage-imageLayout-00005",
2050 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
2051 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002052 }
2053 } else {
2054 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
2055 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002056 skip |= LogError(
2057 image_state->image, "VUID-vkCmdClearColorImage-imageLayout-01394",
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07002058 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
2059 func_name, string_VkImageLayout(dest_image_layout));
2060 }
2061 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002062 }
2063
John Zulauff660ad62019-03-23 07:16:05 -06002064 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06002065 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06002066 if (subresource_map) {
2067 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06002068 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06002069 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
Tony Barbour55688172020-09-23 15:19:50 -07002070 // IncrementInterval skips over all the subresources that have the same state as we just checked, incrementing to
2071 // the next "constant value" range
2072 for (auto pos = subresource_map->Find(normalized_isr); !(pos.AtEnd()) && !subres_skip; pos.IncrementInterval()) {
John Zulauf5e617452019-11-19 14:44:16 -07002073 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06002074 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
2075 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
2076 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
2077 } else {
2078 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002079 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002080 subres_skip |= LogError(cb_node->commandBuffer, error_code,
2081 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
2082 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
2083 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002084 }
John Zulauf5e617452019-11-19 14:44:16 -07002085 }
John Zulauff660ad62019-03-23 07:16:05 -06002086 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002087 }
2088
2089 return skip;
2090}
2091
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002092bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2093 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002094 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002095 bool skip = false;
2096 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06002097 const auto *cb_node = GetCBState(commandBuffer);
2098 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002099 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002100 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002101 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002102 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002103 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002104 if (device_extensions.vk_khr_maintenance1) {
Spencer Fricke6bba8c72020-04-06 07:41:21 -07002105 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
2106 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04002107 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002108 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002109 skip |=
2110 ValidateProtectedImage(cb_node, image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-commandBuffer-01805");
2111 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearColorImage()",
2112 "VUID-vkCmdClearColorImage-commandBuffer-01806");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002113 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002114 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002115 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
sfricke-samsungcd924d92020-05-20 23:51:17 -07002116 skip |= ValidateImageAttributes(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002117 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002118 }
sfricke-samsunge775d492020-02-28 09:02:25 -08002119 // Tests for "Formats requiring sampler Y’CBCR conversion for VK_IMAGE_ASPECT_COLOR_BIT image views"
2120 if (FormatRequiresYcbcrConversion(image_state->createInfo.format)) {
2121 skip |= LogError(device, "VUID-vkCmdClearColorImage-image-01545",
2122 "vkCmdClearColorImage(): format (%s) must not be one of the formats requiring sampler YCBCR "
2123 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
2124 string_VkFormat(image_state->createInfo.format));
2125 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002126 }
2127 return skip;
2128}
2129
John Zulaufeabb4462019-07-05 14:13:03 -06002130void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2131 const VkClearColorValue *pColor, uint32_t rangeCount,
2132 const VkImageSubresourceRange *pRanges) {
2133 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
2134
2135 auto cb_node = GetCBState(commandBuffer);
2136 auto image_state = GetImageState(image);
2137 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002138 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002139 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002140 }
2141 }
2142}
2143
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002144bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2145 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002146 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002147 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002148
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002149 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06002150 const auto *cb_node = GetCBState(commandBuffer);
2151 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002152 if (cb_node && image_state) {
sfricke-samsung30e325a2020-07-25 12:56:13 -07002153 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002154 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002155 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002156 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002157 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002158 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07002159 if (device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002160 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002161 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04002162 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002163 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
sfricke-samsung022fa252020-07-24 03:26:16 -07002164 skip |= ValidateProtectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2165 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01807");
2166 skip |= ValidateUnprotectedImage(cb_node, image_state, "vkCmdClearDepthStencilImage()",
2167 "VUID-vkCmdClearDepthStencilImage-commandBuffer-01808");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002168
2169 bool any_include_aspect_depth_bit = false;
2170 bool any_include_aspect_stencil_bit = false;
2171
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002172 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02002173 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07002174 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002175 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002176 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06002177 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
2178 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002179 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-aspectMask-02824",
2180 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask can only be VK_IMAGE_ASPECT_DEPTH_BIT "
2181 "and/or VK_IMAGE_ASPECT_STENCIL_BIT.",
2182 i);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002183 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002184 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
2185 any_include_aspect_depth_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002186 if (FormatHasDepth(image_format) == false) {
2187 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02826",
2188 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_DEPTH_BIT but %s "
2189 "doesn't have a depth component.",
2190 i, string_VkFormat(image_format));
2191 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002192 }
2193 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
2194 any_include_aspect_stencil_bit = true;
sfricke-samsung30e325a2020-07-25 12:56:13 -07002195 if (FormatHasStencil(image_format) == false) {
2196 skip |= LogError(commandBuffer, "VUID-vkCmdClearDepthStencilImage-image-02825",
2197 "vkCmdClearDepthStencilImage(): pRanges[%u].aspectMask has a VK_IMAGE_ASPECT_STENCIL_BIT but "
2198 "%s doesn't have a stencil component.",
2199 i, string_VkFormat(image_format));
2200 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05002201 }
2202 }
2203 if (any_include_aspect_stencil_bit) {
2204 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
2205 if (image_stencil_struct != nullptr) {
2206 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
2207 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002208 LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
2209 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
2210 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
2211 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05002212 }
2213 } else {
2214 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002215 skip |= LogError(
2216 device, "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
Andrew Fobel3abeb992020-01-20 16:33:22 -05002217 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
2218 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
2219 "in VkImageCreateInfo::usage used to create image");
2220 }
2221 }
2222 }
2223 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002224 skip |= LogError(device, "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
2225 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
2226 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07002227 }
sfricke-samsung30e325a2020-07-25 12:56:13 -07002228 if (image_state && !FormatIsDepthOrStencil(image_format)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002229 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00014",
2230 "vkCmdClearDepthStencilImage(): called with image %s which doesn't have a depth/stencil format (%s).",
sfricke-samsung30e325a2020-07-25 12:56:13 -07002231 report_data->FormatHandle(image).c_str(), string_VkFormat(image_format));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002232 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002233 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
sfricke-samsungcd924d92020-05-20 23:51:17 -07002234 skip |= LogError(image, "VUID-vkCmdClearDepthStencilImage-image-00009",
2235 "vkCmdClearDepthStencilImage(): called with image %s which was not created with the "
2236 "VK_IMAGE_USAGE_TRANSFER_DST_BIT set.",
2237 report_data->FormatHandle(image).c_str());
Tobin Ehlis4af8c242017-11-30 13:47:11 -07002238 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07002239 }
2240 return skip;
2241}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002242
John Zulaufeabb4462019-07-05 14:13:03 -06002243void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2244 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
2245 const VkImageSubresourceRange *pRanges) {
2246 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
2247 auto cb_node = GetCBState(commandBuffer);
2248 auto image_state = GetImageState(image);
2249 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002250 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002251 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002252 }
2253 }
2254}
2255
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002256// Returns true if [x, xoffset] and [y, yoffset] overlap
2257static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
2258 bool result = false;
2259 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
2260 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
2261
2262 if (intersection_max > intersection_min) {
2263 result = true;
2264 }
2265 return result;
2266}
2267
Jeff Leger178b1e52020-10-05 12:22:23 -04002268// Returns true if source area of first vkImageCopy/vkImageCopy2KHR region intersects dest area of second region
Dave Houltonc991cc92018-03-06 11:08:51 -07002269// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
Jeff Leger178b1e52020-10-05 12:22:23 -04002270template <typename RegionType>
2271static bool RegionIntersects(const RegionType *rgn0, const RegionType *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002272 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07002273
Dave Houltonc991cc92018-03-06 11:08:51 -07002274 // Separate planes within a multiplane image cannot intersect
2275 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07002276 return result;
2277 }
2278
Dave Houltonc991cc92018-03-06 11:08:51 -07002279 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
2280 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
2281 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002282 result = true;
2283 switch (type) {
2284 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002285 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002286 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002287 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002288 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002289 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002290 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07002291 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002292 break;
2293 default:
2294 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2295 assert(false);
2296 }
2297 }
2298 return result;
2299}
2300
Dave Houltonfc1a4052017-04-27 14:32:45 -06002301// Returns non-zero if offset and extent exceed image extents
2302static const uint32_t x_bit = 1;
2303static const uint32_t y_bit = 2;
2304static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002305static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002306 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002307 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002308 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2309 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002310 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002311 }
2312 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2313 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002314 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002315 }
2316 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2317 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002318 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002319 }
2320 return result;
2321}
2322
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002323// Test if two VkExtent3D structs are equivalent
2324static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2325 bool result = true;
2326 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2327 (extent->depth != other_extent->depth)) {
2328 result = false;
2329 }
2330 return result;
2331}
2332
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002333// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002334static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002335 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2336}
2337
2338// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002339VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002340 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2341 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002342 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002343 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002344 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002345 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002346 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002347 granularity.width *= block_size.width;
2348 granularity.height *= block_size.height;
2349 }
2350 }
2351 return granularity;
2352}
2353
2354// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2355static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2356 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002357 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2358 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002359 valid = false;
2360 }
2361 return valid;
2362}
2363
2364// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002365bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002366 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002367 bool skip = false;
2368 VkExtent3D offset_extent = {};
2369 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2370 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2371 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002372 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002373 // 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 -07002374 if (IsExtentAllZeroes(&offset_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002375 skip |= LogError(cb_node->commandBuffer, vuid,
2376 "%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 "
2377 "image transfer granularity is (w=0, h=0, d=0).",
2378 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002379 }
2380 } else {
2381 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2382 // integer multiples of the image transfer granularity.
2383 if (IsExtentAligned(&offset_extent, granularity) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002384 skip |= LogError(cb_node->commandBuffer, vuid,
2385 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2386 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
2387 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2388 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002389 }
2390 }
2391 return skip;
2392}
2393
2394// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002395bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002396 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002397 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002398 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002399 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002400 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2401 // subresource extent.
2402 if (IsExtentEqual(extent, subresource_extent) == false) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002403 skip |= LogError(cb_node->commandBuffer, vuid,
2404 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2405 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2406 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2407 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002408 }
2409 } else {
2410 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2411 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2412 // subresource extent dimensions.
2413 VkExtent3D offset_extent_sum = {};
2414 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2415 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2416 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002417 bool x_ok = true;
2418 bool y_ok = true;
2419 bool z_ok = true;
2420 switch (image_type) {
2421 case VK_IMAGE_TYPE_3D:
2422 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2423 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002424 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002425 case VK_IMAGE_TYPE_2D:
2426 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2427 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002428 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002429 case VK_IMAGE_TYPE_1D:
2430 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2431 (subresource_extent->width == offset_extent_sum.width));
2432 break;
2433 default:
2434 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2435 assert(false);
2436 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002437 if (!(x_ok && y_ok && z_ok)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002438 skip |=
2439 LogError(cb_node->commandBuffer, vuid,
2440 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2441 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2442 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2443 function, i, member, extent->width, extent->height, extent->depth, granularity->width, granularity->height,
2444 granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height, extent->depth,
2445 subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002446 }
2447 }
2448 return skip;
2449}
2450
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002451bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002452 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002453 bool skip = false;
2454 if (mip_level >= img->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002455 skip |= LogError(cb_node->commandBuffer, vuid, "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.",
2456 function, i, member, mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002457 }
2458 return skip;
2459}
2460
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002461bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002462 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002463 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002464 bool skip = false;
2465 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2466 (base_layer + layer_count) > img->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002467 skip |= LogError(cb_node->commandBuffer, vuid,
2468 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
2469 "%u, but provided %s has %u array layers.",
2470 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2471 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002472 }
2473 return skip;
2474}
2475
Jeff Leger178b1e52020-10-05 12:22:23 -04002476// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy/VkBufferImageCopy2KHR structure
2477template <typename BufferImageCopyRegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002478bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002479 const BufferImageCopyRegionType *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002480 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002481 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002482 VkExtent3D granularity = GetScaledItg(cb_node, img);
2483 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002484 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002485 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002486 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002487 return skip;
2488}
2489
Jeff Leger178b1e52020-10-05 12:22:23 -04002490// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy/VkImageCopy2KHR structure
2491template <typename RegionType>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002492bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Jeff Leger178b1e52020-10-05 12:22:23 -04002493 const IMAGE_STATE *dst_img, const RegionType *region,
2494 const uint32_t i, const char *function,
2495 CopyCommandVersion version) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002496 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002497 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2498 const char *vuid;
2499
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002500 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002501 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002502 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
2503 skip |= CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002504 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002505 const VkExtent3D extent = region->extent;
Jeff Leger178b1e52020-10-05 12:22:23 -04002506 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-01783" : "VUID-vkCmdCopyImage-srcOffset-01783";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002507 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04002508 i, function, "extent", vuid);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002510 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002511 granularity = GetScaledItg(cb_node, dst_img);
Jeff Leger178b1e52020-10-05 12:22:23 -04002512 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
2513 skip |= CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", vuid);
Dave Houltonee281a52017-12-08 13:51:02 -07002514 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002515 const VkExtent3D dest_effective_extent =
2516 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002517 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Jeff Leger178b1e52020-10-05 12:22:23 -04002518 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-01784" : "VUID-vkCmdCopyImage-dstOffset-01784";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002519 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Jeff Leger178b1e52020-10-05 12:22:23 -04002520 dst_img->createInfo.imageType, i, function, "extent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002521 return skip;
2522}
2523
Jeff Leger178b1e52020-10-05 12:22:23 -04002524// Validate contents of a VkImageCopy or VkImageCopy2KHR struct
2525template <typename ImageCopyRegionType>
2526bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const ImageCopyRegionType *ic_regions,
2527 const IMAGE_STATE *src_state, const IMAGE_STATE *dst_state,
2528 CopyCommandVersion version) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002529 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04002530 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
2531 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2532 const char *vuid;
Dave Houlton6f9059e2017-05-02 17:15:13 -06002533
2534 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002535 const ImageCopyRegionType region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002536
2537 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002538 const VkExtent3D src_copy_extent = region.extent;
2539 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002540 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2541
Dave Houlton6f9059e2017-05-02 17:15:13 -06002542 bool slice_override = false;
2543 uint32_t depth_slices = 0;
2544
2545 // Special case for copying between a 1D/2D array and a 3D image
2546 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2547 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002548 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002549 slice_override = (depth_slices != 1);
2550 } 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 -07002551 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002552 slice_override = (depth_slices != 1);
2553 }
2554
2555 // Do all checks on source image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002556 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002557 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002558 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00146" : "VUID-vkCmdCopyImage-srcImage-00146";
2559 skip |= LogError(src_state->image, vuid,
2560 "%s: pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
2561 "be 0 and 1, respectively.",
2562 func_name, i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002563 }
2564 }
2565
Dave Houlton533be9f2018-03-26 17:08:30 -06002566 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 -04002567 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01785" : "VUID-vkCmdCopyImage-srcImage-01785";
2568 skip |= LogError(src_state->image, vuid,
2569 "%s: pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002570 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002571 func_name, i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002572 }
2573
Dave Houlton533be9f2018-03-26 17:08:30 -06002574 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002575 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01787" : "VUID-vkCmdCopyImage-srcImage-01787";
2576 skip |= LogError(src_state->image, vuid, "%s: pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.",
2577 func_name, i, region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002578 }
2579
Dave Houltonc991cc92018-03-06 11:08:51 -07002580 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002581 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002582 if (FormatIsCompressed(src_state->createInfo.format) ||
2583 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002584 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002585 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002586 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2587 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2588 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002589 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01727" : "VUID-vkCmdCopyImage-srcImage-01727";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002590 skip |= LogError(src_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002591 "%s: pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002592 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002593 func_name, i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002594 }
2595
Dave Houlton94a00372017-12-14 15:08:47 -07002596 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002597 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2598 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002599 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01728" : "VUID-vkCmdCopyImage-srcImage-01728";
2600 skip |= LogError(src_state->image, vuid,
2601 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2602 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
2603 func_name, i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002604 }
2605
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002606 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002607 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2608 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002609 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01729" : "VUID-vkCmdCopyImage-srcImage-01729";
2610 skip |= LogError(src_state->image, vuid,
2611 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
2612 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
2613 func_name, i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002614 }
2615
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002616 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002617 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2618 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002619 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01730" : "VUID-vkCmdCopyImage-srcImage-01730";
2620 skip |= LogError(src_state->image, vuid,
2621 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
2622 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
2623 func_name, i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002624 }
2625 } // Compressed
2626
2627 // Do all checks on dest image
Dave Houlton6f9059e2017-05-02 17:15:13 -06002628 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002629 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002630 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00152" : "VUID-vkCmdCopyImage-dstImage-00152";
2631 skip |= LogError(dst_state->image, vuid,
2632 "%s: pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002633 "these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002634 func_name, i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 }
2636 }
2637
Dave Houlton533be9f2018-03-26 17:08:30 -06002638 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 -04002639 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01786" : "VUID-vkCmdCopyImage-dstImage-01786";
2640 skip |= LogError(dst_state->image, vuid,
2641 "%s: pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
2642 "and 1, respectively.",
2643 func_name, i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002644 }
2645
Dave Houlton533be9f2018-03-26 17:08:30 -06002646 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002647 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01788" : "VUID-vkCmdCopyImage-dstImage-01788";
2648 skip |= LogError(dst_state->image, vuid, "%s: pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.",
2649 func_name, i, region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002650 }
2651
sfricke-samsung30b094c2020-05-30 11:42:11 -07002652 // Handle difference between Maintenance 1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002653 if (device_extensions.vk_khr_maintenance1) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002654 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
2655 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002656 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-04443" : "VUID-vkCmdCopyImage-srcImage-04443";
2657 skip |= LogError(src_state->image, vuid,
2658 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
2659 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2660 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002661 }
2662 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002663 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002664 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002665 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-04444" : "VUID-vkCmdCopyImage-dstImage-04444";
2666 skip |= LogError(dst_state->image, vuid,
2667 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
2668 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2669 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002670 }
2671 }
2672 } else { // Pre maint 1
2673 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
sfricke-samsung30b094c2020-05-30 11:42:11 -07002674 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002675 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2676 skip |= LogError(src_state->image, vuid,
2677 "%s: pRegion[%d] srcSubresource.baseArrayLayer is %d and "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002678 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
2679 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002680 func_name, i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
sfricke-samsung30b094c2020-05-30 11:42:11 -07002681 }
Dave Houltonee281a52017-12-08 13:51:02 -07002682 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002683 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00139" : "VUID-vkCmdCopyImage-srcImage-00139";
2684 skip |= LogError(dst_state->image, vuid,
2685 "%s: pRegion[%d] dstSubresource.baseArrayLayer is %d and "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002686 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
2687 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002688 func_name, i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002689 }
2690 }
2691 }
2692
Dave Houltonc991cc92018-03-06 11:08:51 -07002693 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2694 if (FormatIsCompressed(dst_state->createInfo.format) ||
2695 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002696 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002697
2698 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002699 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2700 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2701 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002702 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01731" : "VUID-vkCmdCopyImage-dstImage-01731";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002703 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002704 "%s: pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002705 "texel width & height (%d, %d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002706 func_name, i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002707 }
2708
Dave Houlton94a00372017-12-14 15:08:47 -07002709 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002710 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2711 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002712 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01732" : "VUID-vkCmdCopyImage-dstImage-01732";
2713 skip |= LogError(dst_state->image, vuid,
2714 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2715 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
2716 func_name, i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002717 }
2718
Dave Houltonee281a52017-12-08 13:51:02 -07002719 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2720 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2721 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002722 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01733" : "VUID-vkCmdCopyImage-dstImage-01733";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002723 skip |= LogError(dst_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04002724 "%s: pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002725 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
2726 "height (%d).",
Jeff Leger178b1e52020-10-05 12:22:23 -04002727 func_name, i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002728 }
2729
Dave Houltonee281a52017-12-08 13:51:02 -07002730 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2731 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2732 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002733 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01734" : "VUID-vkCmdCopyImage-dstImage-01734";
2734 skip |= LogError(dst_state->image, vuid,
2735 "%s: pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
2736 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
2737 func_name, i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002738 }
2739 } // Compressed
2740 }
2741 return skip;
2742}
2743
Jeff Leger178b1e52020-10-05 12:22:23 -04002744// vkCmdCopyImage / vmCmdCopyImage2KHR checks that only apply if the multiplane extension is enabled
2745template <typename RegionType>
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002746bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04002747 const IMAGE_STATE *dst_image_state, const RegionType region,
2748 CopyCommandVersion version) const {
2749 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Dave Houltonc991cc92018-03-06 11:08:51 -07002750 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002751
Jeff Leger178b1e52020-10-05 12:22:23 -04002752 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2753 const char *vuid;
2754
Dave Houltonc991cc92018-03-06 11:08:51 -07002755 // Neither image is multiplane
2756 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2757 // If neither image is multi-plane the aspectMask member of src and dst must match
2758 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2759 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002760 ss << func_name << ": Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002761 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
Jeff Leger178b1e52020-10-05 12:22:23 -04002762 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01551" : "VUID-vkCmdCopyImage-srcImage-01551";
2763 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002764 }
2765 } else {
2766 // Source image multiplane checks
2767 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2768 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2769 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2770 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002771 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2772 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01552" : "VUID-vkCmdCopyImage-srcImage-01552";
2773 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002774 }
2775 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2776 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2777 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002778 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2779 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01553" : "VUID-vkCmdCopyImage-srcImage-01553";
2780 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002781 }
2782 // Single-plane to multi-plane
2783 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2784 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2785 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002786 ss << func_name << ": Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2787 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01557" : "VUID-vkCmdCopyImage-dstImage-01557";
2788 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002789 }
2790
2791 // Dest image multiplane checks
2792 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2793 aspect = region.dstSubresource.aspectMask;
2794 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2795 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002796 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
2797 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01554" : "VUID-vkCmdCopyImage-dstImage-01554";
2798 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002799 }
2800 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2801 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2802 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002803 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
2804 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01555" : "VUID-vkCmdCopyImage-dstImage-01555";
2805 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002806 }
2807 // Multi-plane to single-plane
2808 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2809 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2810 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002811 ss << func_name << ": Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
2812 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01556" : "VUID-vkCmdCopyImage-srcImage-01556";
2813 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002814 }
2815 }
2816
2817 return skip;
2818}
2819
Jeff Leger178b1e52020-10-05 12:22:23 -04002820template <typename RegionType>
2821bool CoreChecks::ValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2822 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2823 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002824 const auto *cb_node = GetCBState(commandBuffer);
2825 const auto *src_image_state = GetImageState(srcImage);
2826 const auto *dst_image_state = GetImageState(dstImage);
sfricke-samsungdce5f692020-03-07 13:59:31 -08002827 const VkFormat src_format = src_image_state->createInfo.format;
2828 const VkFormat dst_format = dst_image_state->createInfo.format;
Jeff Leger178b1e52020-10-05 12:22:23 -04002829 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002830 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002831
Jeff Leger178b1e52020-10-05 12:22:23 -04002832 const char *func_name = is_2khr ? "vkCmdCopyImage2KHR()" : "vkCmdCopyImage()";
2833 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGE2KHR : CMD_COPYIMAGE;
2834 const char *vuid;
2835
2836 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state, version);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002837
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002838 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2839
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002840 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002841 const RegionType region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002842
2843 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2844 VkExtent3D src_copy_extent = region.extent;
sfricke-samsungdce5f692020-03-07 13:59:31 -08002845 VkExtent3D dst_copy_extent = GetAdjustedDestImageExtent(src_format, dst_format, region.extent);
Dave Houltonee281a52017-12-08 13:51:02 -07002846
Dave Houlton6f9059e2017-05-02 17:15:13 -06002847 bool slice_override = false;
2848 uint32_t depth_slices = 0;
2849
2850 // Special case for copying between a 1D/2D array and a 3D image
2851 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2852 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2853 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002854 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002855 slice_override = (depth_slices != 1);
2856 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2857 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002858 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002859 slice_override = (depth_slices != 1);
2860 }
2861
Jeff Leger178b1e52020-10-05 12:22:23 -04002862 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, func_name, "srcSubresource", i);
2863 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, func_name, "dstSubresource", i);
2864 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01696" : "VUID-vkCmdCopyImage-srcSubresource-01696";
2865 skip |=
2866 ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
2867 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01697" : "VUID-vkCmdCopyImage-dstSubresource-01697";
2868 skip |=
2869 ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
2870 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcSubresource-01698" : "VUID-vkCmdCopyImage-srcSubresource-01698";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002871 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002872 region.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
2873 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstSubresource-01699" : "VUID-vkCmdCopyImage-dstSubresource-01699";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002874 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04002875 region.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002876
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002877 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002878 // No chance of mismatch if we're overriding depth slice count
2879 if (!slice_override) {
2880 // The number of depth slices in srcSubresource and dstSubresource must match
2881 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2882 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002883 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2884 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002885 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002886 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2887 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002888 if (src_slices != dst_slices) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002889 vuid = is_2khr ? "VUID-VkImageCopy2KHR-extent-00140" : "VUID-VkImageCopy-extent-00140";
2890 skip |= LogError(command_buffer, vuid,
2891 "%s: number of depth slices in source and destination subresources for "
sfricke-samsung30b094c2020-05-30 11:42:11 -07002892 "pRegions[%u] do not match.",
Jeff Leger178b1e52020-10-05 12:22:23 -04002893 func_name, i);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002894 }
2895 }
2896 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002897 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002898 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002899 vuid = is_2khr ? "VUID-VkImageCopy2KHR-layerCount-00138" : "VUID-VkImageCopy-layerCount-00138";
2900 skip |= LogError(command_buffer, vuid,
2901 "%s: number of layers in source and destination subresources for pRegions[%u] do not match",
2902 func_name, i);
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002903 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002904 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002905
Dave Houltonc991cc92018-03-06 11:08:51 -07002906 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002907 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002908 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region, version);
Dave Houltonc991cc92018-03-06 11:08:51 -07002909 }
2910
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002911 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002912 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2913 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002914 std::stringstream ss;
2915 ss << func_name << ": Src and dest aspectMasks for each region must match";
2916 vuid = is_2khr ? "VUID-VkImageCopy2KHR-aspectMask-00137" : "VUID-VkImageCopy-aspectMask-00137";
2917 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houltonf5217612018-02-02 16:18:52 -07002918 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002919 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002920
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002921 // For each region, the aspectMask member of srcSubresource must be present in the source image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002922 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002923 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002924 ss << func_name << ": pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002925 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
Jeff Leger178b1e52020-10-05 12:22:23 -04002926 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00142" : "VUID-vkCmdCopyImage-aspectMask-00142";
2927 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002928 }
2929
2930 // For each region, the aspectMask member of dstSubresource must be present in the destination image
sfricke-samsungdce5f692020-03-07 13:59:31 -08002931 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002932 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002933 ss << func_name << ": pRegion[" << i << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
2934 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-aspectMask-00143" : "VUID-vkCmdCopyImage-aspectMask-00143";
2935 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002936 }
2937
Dave Houltonfc1a4052017-04-27 14:32:45 -06002938 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002939 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2940 if (slice_override) src_copy_extent.depth = depth_slices;
2941 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002942 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002943 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00144" : "VUID-vkCmdCopyImage-srcOffset-00144";
2944 skip |= LogError(command_buffer, vuid,
2945 "%s: Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2946 "width [%1d].",
2947 func_name, i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002948 }
2949
2950 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002951 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00145" : "VUID-vkCmdCopyImage-srcOffset-00145";
2952 skip |= LogError(command_buffer, vuid,
2953 "%s: Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2954 "height [%1d].",
2955 func_name, i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002956 }
2957 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002958 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcOffset-00147" : "VUID-vkCmdCopyImage-srcOffset-00147";
2959 skip |= LogError(command_buffer, vuid,
2960 "%s: Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2961 "depth [%1d].",
2962 func_name, i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002963 }
2964
Dave Houltonee281a52017-12-08 13:51:02 -07002965 // Adjust dest extent if necessary
2966 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2967 if (slice_override) dst_copy_extent.depth = depth_slices;
2968
2969 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002970 if (extent_check & x_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002971 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00150" : "VUID-vkCmdCopyImage-dstOffset-00150";
2972 skip |= LogError(command_buffer, vuid,
2973 "%s: Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002974 "width [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002975 func_name, i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002976 }
2977 if (extent_check & y_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002978 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00151" : "VUID-vkCmdCopyImage-dstOffset-00151";
2979 skip |= LogError(command_buffer, vuid,
2980 "%s): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002981 "height [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002982 func_name, i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002983 }
2984 if (extent_check & z_bit) {
Jeff Leger178b1e52020-10-05 12:22:23 -04002985 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstOffset-00153" : "VUID-vkCmdCopyImage-dstOffset-00153";
2986 skip |= LogError(command_buffer, vuid,
2987 "%s: Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07002988 "depth [%1d].",
Jeff Leger178b1e52020-10-05 12:22:23 -04002989 func_name, i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002990 }
2991
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002992 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2993 // must not overlap in memory
2994 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002995 for (uint32_t j = 0; j < regionCount; j++) {
2996 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
sfricke-samsungdce5f692020-03-07 13:59:31 -08002997 FormatIsMultiplane(src_format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002998 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04002999 ss << func_name << ": pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
3000 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-pRegions-00124" : "VUID-vkCmdCopyImage-pRegions-00124";
3001 skip |= LogError(command_buffer, vuid, "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003002 }
3003 }
3004 }
sfricke-samsung48172ca2020-02-13 23:38:11 -08003005
3006 // Check depth for 2D as post Maintaince 1 requires both while prior only required one to be 2D
3007 if (device_extensions.vk_khr_maintenance1) {
3008 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3009 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3010 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003011 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01790" : "VUID-vkCmdCopyImage-srcImage-01790";
3012 skip |= LogError(command_buffer, vuid,
3013 "%s: pRegion[%u] both srcImage and dstImage are 2D and extent.depth is %u and has to be 1",
3014 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003015 }
3016 } else {
3017 if (((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) ||
3018 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType)) &&
3019 (src_copy_extent.depth != 1)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003020 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01789" : "VUID-vkCmdCopyImage-srcImage-01789";
3021 skip |= LogError(command_buffer, vuid,
3022 "%s: pRegion[%u] either srcImage or dstImage is 2D and extent.depth is %u and has to be 1",
3023 func_name, i, src_copy_extent.depth);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003024 }
3025 }
3026
3027 // Check if 2D with 3D and depth not equal to 2D layerCount
3028 if ((VK_IMAGE_TYPE_2D == src_image_state->createInfo.imageType) &&
3029 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
3030 (src_copy_extent.depth != region.srcSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003031 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01791" : "VUID-vkCmdCopyImage-srcImage-01791";
3032 skip |= LogError(command_buffer, vuid,
3033 "%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 -08003034 "srcSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003035 func_name, i, src_copy_extent.depth, region.srcSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003036 } else if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
3037 (VK_IMAGE_TYPE_2D == dst_image_state->createInfo.imageType) &&
3038 (src_copy_extent.depth != region.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003039 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01792" : "VUID-vkCmdCopyImage-dstImage-01792";
3040 skip |= LogError(command_buffer, vuid,
3041 "%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 -08003042 "dstSubresource.layerCount (%u)",
Jeff Leger178b1e52020-10-05 12:22:23 -04003043 func_name, i, src_copy_extent.depth, region.dstSubresource.layerCount);
sfricke-samsung48172ca2020-02-13 23:38:11 -08003044 }
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003045
3046 // Check for multi-plane format compatiblity
3047 if (FormatIsMultiplane(src_format) || FormatIsMultiplane(dst_format)) {
3048 size_t src_format_size = 0;
3049 size_t dst_format_size = 0;
3050 if (FormatIsMultiplane(src_format)) {
3051 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(src_format, region.srcSubresource.aspectMask);
3052 src_format_size = FormatElementSize(planeFormat);
3053 } else {
3054 src_format_size = FormatElementSize(src_format);
3055 }
3056 if (FormatIsMultiplane(dst_format)) {
3057 const VkFormat planeFormat = FindMultiplaneCompatibleFormat(dst_format, region.dstSubresource.aspectMask);
3058 dst_format_size = FormatElementSize(planeFormat);
3059 } else {
3060 dst_format_size = FormatElementSize(dst_format);
3061 }
3062 // If size is still zero, then format is invalid and will be caught in another VU
3063 if ((src_format_size != dst_format_size) && (src_format_size != 0) && (dst_format_size != 0)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003064 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-None-01549" : "VUID-vkCmdCopyImage-None-01549";
3065 skip |= LogError(command_buffer, vuid,
3066 "%s: pRegions[%u] called with non-compatible image formats. "
3067 "The src format %s with aspectMask %s is not compatible with dst format %s aspectMask %s.",
3068 func_name, i, string_VkFormat(src_format),
3069 string_VkImageAspectFlags(region.srcSubresource.aspectMask).c_str(), string_VkFormat(dst_format),
3070 string_VkImageAspectFlags(region.dstSubresource.aspectMask).c_str());
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003071 }
3072 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003073 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003074
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003075 // The formats of non-multiplane src_image and dst_image must be compatible. Formats are considered compatible if their texel
3076 // size in bytes is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT
3077 // because because both texels are 4 bytes in size.
3078 if (!FormatIsMultiplane(src_format) && !FormatIsMultiplane(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003079 const char *compatible_vuid =
3080 (device_extensions.vk_khr_sampler_ycbcr_conversion)
3081 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01548" : "VUID-vkCmdCopyImage-srcImage-01548")
3082 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00135" : "VUID-vkCmdCopyImage-srcImage-00135");
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003083 // Depth/stencil formats must match exactly.
3084 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3085 if (src_format != dst_format) {
3086 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003087 "%s: Depth/stencil formats must match exactly for src (%s) and dst (%s).", func_name,
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003088 string_VkFormat(src_format), string_VkFormat(dst_format));
3089 }
3090 } else {
Jeff Leger178b1e52020-10-05 12:22:23 -04003091 if (FormatElementSize(src_format) != FormatElementSize(dst_format)) {
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003092 skip |= LogError(command_buffer, compatible_vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04003093 "%s: Unmatched image format sizes. "
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003094 "The src format %s has size of %zu and dst format %s has size of %zu.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003095 func_name, string_VkFormat(src_format), FormatElementSize(src_format), string_VkFormat(dst_format),
sfricke-samsung99dc12c2020-04-23 01:52:01 -07003096 FormatElementSize(dst_format));
3097 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003098 }
3099 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003100
Dave Houlton33c22b72017-02-28 13:16:02 -07003101 // Source and dest image sample counts must match
3102 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003103 std::stringstream ss;
3104 ss << func_name << " called on image pair with non-identical sample counts.";
3105 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00136" : "VUID-vkCmdCopyImage-srcImage-00136";
3106 skip |= LogError(command_buffer, vuid, "%s", ss.str().c_str());
Dave Houlton33c22b72017-02-28 13:16:02 -07003107 }
3108
Jeff Leger178b1e52020-10-05 12:22:23 -04003109 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00127" : "VUID-vkCmdCopyImage-srcImage-00127";
3110 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3111 vuid = is_2khr ? "" : "";
3112 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003113 // Validate that SRC & DST images have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04003114 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-00126" : "VUID-vkCmdCopyImage-srcImage-00126";
3115 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3116 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3117 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-00131" : "VUID-vkCmdCopyImage-dstImage-00131";
3118 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3119 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3120 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01825" : "VUID-vkCmdCopyImage-commandBuffer-01825";
3121 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3122 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01826" : "VUID-vkCmdCopyImage-commandBuffer-01826";
3123 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3124 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-01827" : "VUID-vkCmdCopyImage-commandBuffer-01827";
3125 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003126
3127 // Validation for VK_EXT_fragment_density_map
3128 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003129 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3130 skip |=
3131 LogError(command_buffer, vuid,
3132 "%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 +02003133 }
3134 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003135 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-02542" : "VUID-vkCmdCopyImage-dstImage-02542";
3136 skip |=
3137 LogError(command_buffer, vuid,
3138 "%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 +02003139 }
3140
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07003141 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003142 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImage-01995" : "VUID-vkCmdCopyImage-srcImage-01995";
3143 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
3144 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImage-01996" : "VUID-vkCmdCopyImage-dstImage-01996";
3145 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003146 }
Jeff Leger178b1e52020-10-05 12:22:23 -04003147 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImage-commandBuffer-cmdpool";
3148 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
3149 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3150 vuid = is_2khr ? "VUID-vkCmdCopyImage2KHR-renderpass" : "VUID-vkCmdCopyImage-renderpass";
3151 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06003152 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003153
3154 const char *invalid_src_layout_vuid =
3155 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3156 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-01917" : "VUID-vkCmdCopyImage-srcImageLayout-01917")
3157 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00129" : "VUID-vkCmdCopyImage-srcImageLayout-00129");
3158 const char *invalid_dst_layout_vuid =
3159 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3160 ? (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-01395" : "VUID-vkCmdCopyImage-dstImageLayout-01395")
3161 : (is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00134" : "VUID-vkCmdCopyImage-dstImageLayout-00134");
3162
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003163 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003164 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-srcImageLayout-00128" : "VUID-vkCmdCopyImage-srcImageLayout-00128";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003165 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003166 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3167 vuid = is_2khr ? "VUID-VkCopyImageInfo2KHR-dstImageLayout-00133" : "VUID-vkCmdCopyImage-dstImageLayout-00133";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003168 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003169 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003170 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
Jeff Leger178b1e52020-10-05 12:22:23 -04003171 func_name, version);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003172 }
3173
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07003174 return skip;
3175}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003176
Jeff Leger178b1e52020-10-05 12:22:23 -04003177bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3178 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3179 const VkImageCopy *pRegions) const {
3180 return ValidateCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3181 COPY_COMMAND_VERSION_1);
3182}
3183
3184bool CoreChecks::PreCallValidateCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) const {
3185 return ValidateCmdCopyImage(commandBuffer, pCopyImageInfo->srcImage, pCopyImageInfo->srcImageLayout, pCopyImageInfo->dstImage,
3186 pCopyImageInfo->dstImageLayout, pCopyImageInfo->regionCount, pCopyImageInfo->pRegions,
3187 COPY_COMMAND_VERSION_2);
3188}
3189
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003190void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3191 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3192 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003193 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3194 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003195 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003196 auto src_image_state = GetImageState(srcImage);
3197 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003198
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003199 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07003200 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003201 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3202 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06003203 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07003204}
3205
Jeff Leger178b1e52020-10-05 12:22:23 -04003206void CoreChecks::PreCallRecordCmdCopyImage2KHR(VkCommandBuffer commandBuffer, const VkCopyImageInfo2KHR *pCopyImageInfo) {
3207 StateTracker::PreCallRecordCmdCopyImage2KHR(commandBuffer, pCopyImageInfo);
3208 auto cb_node = GetCBState(commandBuffer);
3209 auto src_image_state = GetImageState(pCopyImageInfo->srcImage);
3210 auto dst_image_state = GetImageState(pCopyImageInfo->dstImage);
3211
3212 // Make sure that all image slices are updated to correct layout
3213 for (uint32_t i = 0; i < pCopyImageInfo->regionCount; ++i) {
3214 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageInfo->pRegions[i].srcSubresource,
3215 pCopyImageInfo->srcImageLayout);
3216 SetImageInitialLayout(cb_node, *dst_image_state, pCopyImageInfo->pRegions[i].dstSubresource,
3217 pCopyImageInfo->dstImageLayout);
3218 }
3219}
3220
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003221// Returns true if sub_rect is entirely contained within rect
3222static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
3223 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
3224 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
3225 return false;
3226 return true;
3227}
3228
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003229bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003230 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
locke-lunargfc78e932020-11-19 17:06:24 -07003231 const VkRect2D &render_area, uint32_t rect_count, const VkClearRect *clear_rects,
3232 const CMD_BUFFER_STATE *primary_cb_state) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07003233 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07003234 const IMAGE_VIEW_STATE *image_view_state = nullptr;
3235 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
locke-lunargfc78e932020-11-19 17:06:24 -07003236 image_view_state = GetActiveAttachmentImageViewState(GetCBState(command_buffer), fb_attachment, primary_cb_state);
John Zulauff2582972019-02-09 14:53:30 -07003237 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003238
3239 for (uint32_t j = 0; j < rect_count; j++) {
3240 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003241 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00016",
3242 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
3243 "the current render pass instance.",
3244 j);
John Zulauf3a548ef2019-02-01 16:14:07 -07003245 }
3246
3247 if (image_view_state) {
3248 // The layers specified by a given element of pRects must be contained within every attachment that
3249 // pAttachments refers to
3250 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
3251 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
3252 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003253 skip |= LogError(command_buffer, "VUID-vkCmdClearAttachments-pRects-00017",
3254 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
3255 "of pAttachment[%d].",
3256 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07003257 }
3258 }
3259 }
3260 return skip;
3261}
3262
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003263bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3264 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003265 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003266 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06003267 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02003268 if (!cb_node) return skip;
3269
3270 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
3271 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
3272 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02003273 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003274
3275 // Validate that attachment is in reference list of active subpass
3276 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003277 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07003278 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003279 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
locke-lunargaecf2152020-05-12 17:15:41 -06003280 const auto *framebuffer = cb_node->activeFramebuffer.get();
John Zulauf3a548ef2019-02-01 16:14:07 -07003281 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003282
John Zulauf3a548ef2019-02-01 16:14:07 -07003283 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3284 auto clear_desc = &pAttachments[attachment_index];
3285 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003286 const VkImageAspectFlags aspect_mask = clear_desc->aspectMask;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003287
sfricke-samsungfdf91c82020-10-26 03:31:28 -07003288 if (aspect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
3289 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00020",
3290 "vkCmdClearAttachments() pAttachments[%u] mask contains VK_IMAGE_ASPECT_METADATA_BIT",
3291 attachment_index);
3292 } else if (aspect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
3293 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
3294 skip |=
3295 LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-02246",
3296 "vkCmdClearAttachments() pAttachments[%u] mask contains a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit",
3297 attachment_index);
3298 } else if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07003299 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
3300 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
3301 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3302 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003303 skip |= LogError(
3304 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3305 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
3306 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
3307 attachment_index, clear_desc->colorAttachment,
3308 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
3309 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07003310
John Zulauff2582972019-02-09 14:53:30 -07003311 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
3312 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003313 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003314 skip |= LogError(commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02501",
3315 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
3316 " subpass %u. colorAttachmentCount=%u",
3317 attachment_index, clear_desc->colorAttachment,
3318 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
3319 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003320 }
John Zulauff2582972019-02-09 14:53:30 -07003321 fb_attachment = color_attachment;
3322
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003323 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
3324 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
3325 skip |= LogError(commandBuffer, "VUID-VkClearAttachment-aspectMask-00019",
3326 "vkCmdClearAttachments() pAttachments[%u] aspectMask must set only VK_IMAGE_ASPECT_COLOR_BIT "
3327 "of a color attachment.",
3328 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003329 }
3330 } else { // Must be depth and/or stencil
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003331 bool subpass_depth = false;
3332 bool subpass_stencil = false;
3333 if (subpass_desc->pDepthStencilAttachment &&
3334 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3335 auto index = subpass_desc->pDepthStencilAttachment->attachment;
3336 subpass_depth = FormatHasDepth(renderpass_create_info->pAttachments[index].format);
3337 subpass_stencil = FormatHasStencil(renderpass_create_info->pAttachments[index].format);
3338 }
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003339 if (!subpass_desc->pDepthStencilAttachment ||
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003340 (subpass_desc->pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED)) {
3341 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) && !subpass_depth) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003342 skip |= LogError(
3343 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02502",
3344 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_DEPTH_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003345 "depth attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003346 attachment_index);
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003347 }
3348 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) && !subpass_stencil) {
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003349 skip |= LogError(
3350 commandBuffer, "VUID-vkCmdClearAttachments-aspectMask-02503",
3351 "vkCmdClearAttachments() pAttachments[%u] aspectMask has VK_IMAGE_ASPECT_STENCIL_BIT but there is no "
Tony-LunarG1b2f8302020-10-29 13:26:23 -06003352 "stencil attachment in subpass",
sfricke-samsungf1f35ce2020-10-26 03:35:35 -07003353 attachment_index);
3354 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003355 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003356 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003357 }
3358 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003359 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003360 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3361 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003362 }
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003363
3364 // Once the framebuffer attachment is found, can get the image view state
3365 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) &&
3366 (fb_attachment < framebuffer->createInfo.attachmentCount)) {
3367 const IMAGE_VIEW_STATE *image_view_state =
locke-lunargfc78e932020-11-19 17:06:24 -07003368 GetActiveAttachmentImageViewState(GetCBState(commandBuffer), fb_attachment);
sfricke-samsung3d0c0b12020-08-04 00:21:37 -07003369 if (image_view_state != nullptr) {
3370 skip |= ValidateProtectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3371 "VUID-vkCmdClearAttachments-commandBuffer-02504");
3372 skip |= ValidateUnprotectedImage(cb_node, image_view_state->image_state.get(), "vkCmdClearAttachments()",
3373 "VUID-vkCmdClearAttachments-commandBuffer-02505");
3374 }
3375 }
John Zulauf441558b2019-08-12 11:47:39 -06003376 }
3377 }
3378 return skip;
3379}
3380
3381void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3382 const VkClearAttachment *pAttachments, uint32_t rectCount,
3383 const VkClearRect *pRects) {
3384 auto *cb_node = GetCBState(commandBuffer);
3385 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3386 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3387 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3388 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3389 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3390 const auto clear_desc = &pAttachments[attachment_index];
3391 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3392 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3393 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3394 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3395 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3396 subpass_desc->pDepthStencilAttachment) {
3397 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3398 }
3399 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003400 if (!clear_rect_copy) {
3401 // We need a copy of the clear rectangles that will persist until the last lambda executes
3402 // but we want to create it as lazily as possible
3403 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003404 }
John Zulauf441558b2019-08-12 11:47:39 -06003405 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3406 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003407 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
locke-lunargaecf2152020-05-12 17:15:41 -06003408 const CMD_BUFFER_STATE *prim_cb, const FRAMEBUFFER_STATE *fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003409 assert(rectCount == clear_rect_copy->size());
John Zulauf3a548ef2019-02-01 16:14:07 -07003410 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3411 bool skip = false;
locke-lunargaecf2152020-05-12 17:15:41 -06003412 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, fb, fb_attachment, render_area, rectCount,
locke-lunargfc78e932020-11-19 17:06:24 -07003413 clear_rect_copy->data(), prim_cb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003414 return skip;
3415 };
3416 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003417 }
3418 }
3419 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003420}
3421
Jeff Leger178b1e52020-10-05 12:22:23 -04003422template <typename RegionType>
3423bool CoreChecks::ValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3424 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3425 const RegionType *pRegions, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003426 const auto *cb_node = GetCBState(commandBuffer);
3427 const auto *src_image_state = GetImageState(srcImage);
3428 const auto *dst_image_state = GetImageState(dstImage);
Jeff Leger178b1e52020-10-05 12:22:23 -04003429 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3430 const char *func_name = is_2khr ? "vkCmdResolveImage2KHR()" : "vkCmdResolveImage()";
3431 const CMD_TYPE cmd_type = is_2khr ? CMD_RESOLVEIMAGE : CMD_RESOLVEIMAGE2KHR;
3432 const char *vuid;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003433
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003434 bool skip = false;
3435 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003436 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00256" : "VUID-vkCmdResolveImage-srcImage-00256";
3437 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3438 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00258" : "VUID-vkCmdResolveImage-dstImage-00258";
3439 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3440 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdResolveImage-commandBuffer-cmdpool";
3441 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3442 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3443 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-renderpass" : "VUID-vkCmdResolveImage-renderpass";
3444 skip |= InsideRenderPass(cb_node, func_name, vuid);
3445 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02003" : "VUID-vkCmdResolveImage-dstImage-02003";
3446 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, func_name, vuid);
3447 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01837" : "VUID-vkCmdResolveImage-commandBuffer-01837";
3448 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3449 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01838" : "VUID-vkCmdResolveImage-commandBuffer-01838";
3450 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3451 vuid = is_2khr ? "VUID-vkCmdResolveImage2KHR-commandBuffer-01839" : "VUID-vkCmdResolveImage-commandBuffer-01839";
3452 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003453
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003454 // Validation for VK_EXT_fragment_density_map
3455 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003456 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3457 skip |= LogError(cb_node->commandBuffer, vuid,
3458 "%s: srcImage must not have been created with flags containing "
3459 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3460 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003461 }
3462 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003463 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-02546" : "VUID-vkCmdResolveImage-dstImage-02546";
3464 skip |= LogError(cb_node->commandBuffer, vuid,
3465 "%s: dstImage must not have been created with flags containing "
3466 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3467 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003468 }
3469
Cort Stratton7df30962018-05-17 19:45:57 -07003470 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003471 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003472 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3473 ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-01400"
Shannon McPhersonc505df62020-10-20 16:27:11 -06003474 : "VUID-VkResolveImageInfo2KHR-srcImageLayout-00261")
Jeff Leger178b1e52020-10-05 12:22:23 -04003475 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3476 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3477 : "VUID-vkCmdResolveImage-srcImageLayout-00261");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003478 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003479 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3480 ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-01401"
3481 : "VUID-VkResolveImageInfo2KHR-dstImageLayout-00263")
3482 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3483 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3484 : "VUID-vkCmdResolveImage-dstImageLayout-00263");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003485 // For each region, the number of layers in the image subresource should not be zero
3486 // For each region, src and dest image aspect must be color only
3487 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003488 const RegionType region = pRegions[i];
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003489 const VkImageSubresourceLayers src_subresource = region.srcSubresource;
3490 const VkImageSubresourceLayers dst_subresource = region.dstSubresource;
Jeff Leger178b1e52020-10-05 12:22:23 -04003491 skip |= ValidateImageSubresourceLayers(cb_node, &src_subresource, func_name, "srcSubresource", i);
3492 skip |= ValidateImageSubresourceLayers(cb_node, &dst_subresource, func_name, "dstSubresource", i);
3493 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImageLayout-00260" : "VUID-vkCmdResolveImage-srcImageLayout-00260";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003494 skip |= VerifyImageLayout(cb_node, src_image_state, src_subresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003495 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3496 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImageLayout-00262" : "VUID-vkCmdResolveImage-dstImageLayout-00262";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003497 skip |= VerifyImageLayout(cb_node, dst_image_state, dst_subresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003498 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3499 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01709" : "VUID-vkCmdResolveImage-srcSubresource-01709";
3500 skip |= ValidateImageMipLevel(cb_node, src_image_state, src_subresource.mipLevel, i, func_name, "srcSubresource", vuid);
3501 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01710" : "VUID-vkCmdResolveImage-dstSubresource-01710";
3502 skip |= ValidateImageMipLevel(cb_node, dst_image_state, dst_subresource.mipLevel, i, func_name, "dstSubresource", vuid);
3503 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcSubresource-01711" : "VUID-vkCmdResolveImage-srcSubresource-01711";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003504 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, src_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003505 src_subresource.layerCount, i, func_name, "srcSubresource", vuid);
3506 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstSubresource-01712" : "VUID-vkCmdResolveImage-dstSubresource-01712";
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003507 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, dst_subresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003508 dst_subresource.layerCount, i, func_name, "srcSubresource", vuid);
Cort Stratton7df30962018-05-17 19:45:57 -07003509
3510 // layer counts must match
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003511 if (src_subresource.layerCount != dst_subresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003512 vuid = is_2khr ? "VUID-VkImageResolve2KHR-layerCount-00267" : "VUID-VkImageResolve-layerCount-00267";
3513 skip |=
3514 LogError(cb_node->commandBuffer, vuid,
3515 "%s: layerCount in source and destination subresource of pRegions[%u] does not match.", func_name, i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003516 }
Cort Stratton7df30962018-05-17 19:45:57 -07003517 // For each region, src and dest image aspect must be color only
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003518 if ((src_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3519 (dst_subresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003520 vuid = is_2khr ? "VUID-VkImageResolve2KHR-aspectMask-00266" : "VUID-VkImageResolve-aspectMask-00266";
3521 skip |= LogError(cb_node->commandBuffer, vuid,
3522 "%s: src and dest aspectMasks for pRegions[%u] must specify only VK_IMAGE_ASPECT_COLOR_BIT.",
3523 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003524 }
3525
3526 const VkImageType src_image_type = src_image_state->createInfo.imageType;
3527 const VkImageType dst_image_type = dst_image_state->createInfo.imageType;
3528
3529 if ((VK_IMAGE_TYPE_3D == src_image_type) || (VK_IMAGE_TYPE_3D == dst_image_type)) {
Shannon McPherson74b341c2020-09-08 15:43:05 -06003530 if ((0 != src_subresource.baseArrayLayer) || (1 != src_subresource.layerCount)) {
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003531 LogObjectList objlist(cb_node->commandBuffer);
3532 objlist.add(src_image_state->image);
3533 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003534 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04446" : "VUID-vkCmdResolveImage-srcImage-04446";
3535 skip |= LogError(objlist, vuid,
3536 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
Shannon McPherson74b341c2020-09-08 15:43:05 -06003537 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003538 func_name, i);
Shannon McPherson74b341c2020-09-08 15:43:05 -06003539 }
3540 if ((0 != dst_subresource.baseArrayLayer) || (1 != dst_subresource.layerCount)) {
3541 LogObjectList objlist(cb_node->commandBuffer);
3542 objlist.add(src_image_state->image);
3543 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003544 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-04447" : "VUID-vkCmdResolveImage-srcImage-04447";
3545 skip |= LogError(objlist, vuid,
3546 "%s: pRegions[%u] baseArrayLayer must be 0 and layerCount must be 1 for all "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003547 "subresources if the src or dst image is 3D.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003548 func_name, i);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003549 }
3550 }
3551
3552 if (VK_IMAGE_TYPE_1D == src_image_type) {
3553 if ((pRegions[i].srcOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3554 LogObjectList objlist(cb_node->commandBuffer);
3555 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003556 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00271" : "VUID-vkCmdResolveImage-srcImage-00271";
3557 skip |= LogError(objlist, vuid,
3558 "%s: srcImage (%s) is 1D but pRegions[%u] srcOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003559 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003560 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3561 pRegions[i].srcOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003562 }
3563 }
3564 if ((VK_IMAGE_TYPE_1D == src_image_type) || (VK_IMAGE_TYPE_2D == src_image_type)) {
3565 if ((pRegions[i].srcOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3566 LogObjectList objlist(cb_node->commandBuffer);
3567 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003568 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00273" : "VUID-vkCmdResolveImage-srcImage-00273";
3569 skip |= LogError(objlist, vuid,
3570 "%s: srcImage (%s) is 2D but pRegions[%u] srcOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003571 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003572 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i,
3573 pRegions[i].srcOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003574 }
3575 }
3576
3577 if (VK_IMAGE_TYPE_1D == dst_image_type) {
3578 if ((pRegions[i].dstOffset.y != 0) || (pRegions[i].extent.height != 1)) {
3579 LogObjectList objlist(cb_node->commandBuffer);
3580 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003581 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00276" : "VUID-vkCmdResolveImage-dstImage-00276";
3582 skip |= LogError(objlist, vuid,
3583 "%s: dstImage (%s) is 1D but pRegions[%u] dstOffset.y (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003584 "extent.height (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003585 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3586 pRegions[i].dstOffset.y, pRegions[i].extent.height);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003587 }
3588 }
3589 if ((VK_IMAGE_TYPE_1D == dst_image_type) || (VK_IMAGE_TYPE_2D == dst_image_type)) {
3590 if ((pRegions[i].dstOffset.z != 0) || (pRegions[i].extent.depth != 1)) {
3591 LogObjectList objlist(cb_node->commandBuffer);
3592 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003593 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00278" : "VUID-vkCmdResolveImage-dstImage-00278";
3594 skip |= LogError(objlist, vuid,
3595 "%s: dstImage (%s) is 2D but pRegions[%u] dstOffset.z (%d) is not 0 or "
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003596 "extent.depth (%u) is not 1.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003597 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i,
3598 pRegions[i].dstOffset.z, pRegions[i].extent.depth);
sfricke-samsung2e94fb02020-06-05 21:59:28 -07003599 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003600 }
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003601
3602 // Each srcImage dimension offset + extent limits must fall with image subresource extent
3603 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &src_subresource);
3604 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3605 // developer
3606 if (src_subresource.mipLevel < src_image_state->createInfo.mipLevels) {
3607 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &(region.extent), &subresource_extent);
3608 if ((extent_check & x_bit) != 0) {
3609 LogObjectList objlist(cb_node->commandBuffer);
3610 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003611 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00269" : "VUID-vkCmdResolveImage-srcOffset-00269";
3612 skip |= LogError(objlist, vuid,
3613 "%s: srcImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003614 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003615 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003616 region.extent.width, subresource_extent.width);
3617 }
3618
3619 if ((extent_check & y_bit) != 0) {
3620 LogObjectList objlist(cb_node->commandBuffer);
3621 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003622 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00270" : "VUID-vkCmdResolveImage-srcOffset-00270";
3623 skip |= LogError(objlist, vuid,
3624 "%s: srcImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003625 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003626 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003627 region.extent.height, subresource_extent.height);
3628 }
3629
3630 if ((extent_check & z_bit) != 0) {
3631 LogObjectList objlist(cb_node->commandBuffer);
3632 objlist.add(src_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003633 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcOffset-00272" : "VUID-vkCmdResolveImage-srcOffset-00272";
3634 skip |= LogError(objlist, vuid,
3635 "%s: srcImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003636 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003637 func_name, report_data->FormatHandle(src_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003638 region.extent.depth, subresource_extent.depth);
3639 }
3640 }
3641
3642 // Each dstImage dimension offset + extent limits must fall with image subresource extent
3643 subresource_extent = GetImageSubresourceExtent(dst_image_state, &dst_subresource);
3644 // MipLevel bound is checked already and adding extra errors with a "subresource extent of zero" is confusing to
3645 // developer
3646 if (dst_subresource.mipLevel < dst_image_state->createInfo.mipLevels) {
3647 uint32_t extent_check = ExceedsBounds(&(region.dstOffset), &(region.extent), &subresource_extent);
3648 if ((extent_check & x_bit) != 0) {
3649 LogObjectList objlist(cb_node->commandBuffer);
3650 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003651 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00274" : "VUID-vkCmdResolveImage-dstOffset-00274";
3652 skip |= LogError(objlist, vuid,
3653 "%s: dstImage (%s) pRegions[%u] x-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003654 "exceeds subResource width [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003655 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.x,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003656 region.extent.width, subresource_extent.width);
3657 }
3658
3659 if ((extent_check & y_bit) != 0) {
3660 LogObjectList objlist(cb_node->commandBuffer);
3661 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003662 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00275" : "VUID-vkCmdResolveImage-dstOffset-00275";
3663 skip |= LogError(objlist, vuid,
3664 "%s: dstImage (%s) pRegions[%u] y-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003665 "exceeds subResource height [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003666 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.y,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003667 region.extent.height, subresource_extent.height);
3668 }
3669
3670 if ((extent_check & z_bit) != 0) {
3671 LogObjectList objlist(cb_node->commandBuffer);
3672 objlist.add(dst_image_state->image);
Jeff Leger178b1e52020-10-05 12:22:23 -04003673 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstOffset-00277" : "VUID-vkCmdResolveImage-dstOffset-00277";
3674 skip |= LogError(objlist, vuid,
3675 "%s: dstImage (%s) pRegions[%u] z-dimension offset [%1d] + extent [%u] "
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003676 "exceeds subResource depth [%u].",
Jeff Leger178b1e52020-10-05 12:22:23 -04003677 func_name, report_data->FormatHandle(dst_image_state->image).c_str(), i, region.srcOffset.z,
sfricke-samsungdfeb3172020-07-25 21:17:07 -07003678 region.extent.depth, subresource_extent.depth);
3679 }
3680 }
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003681 }
3682
3683 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003684 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-01386" : "VUID-vkCmdResolveImage-srcImage-01386";
3685 skip |= LogError(cb_node->commandBuffer, vuid, "%s: srcImage format (%s) and dstImage format (%s) are not the same.",
3686 func_name, string_VkFormat(src_image_state->createInfo.format),
3687 string_VkFormat(dst_image_state->createInfo.format));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003688 }
3689 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
sfricke-samsungc26350e2020-05-30 12:31:31 -07003690 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_MismatchedImageType,
Jeff Leger178b1e52020-10-05 12:22:23 -04003691 "%s: srcImage type (%s) and dstImage type (%s) are not the same.", func_name,
sfricke-samsungc26350e2020-05-30 12:31:31 -07003692 string_VkImageType(src_image_state->createInfo.imageType),
3693 string_VkImageType(dst_image_state->createInfo.imageType));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003694 }
3695 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003696 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-srcImage-00257" : "VUID-vkCmdResolveImage-srcImage-00257";
3697 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 -07003698 }
3699 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003700 vuid = is_2khr ? "VUID-VkResolveImageInfo2KHR-dstImage-00259" : "VUID-vkCmdResolveImage-dstImage-00259";
3701 skip |= LogError(cb_node->commandBuffer, vuid, "%s: dstImage sample count (%s) is not VK_SAMPLE_COUNT_1_BIT.",
3702 func_name, string_VkSampleCountFlagBits(dst_image_state->createInfo.samples));
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003703 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003704 } else {
3705 assert(0);
3706 }
3707 return skip;
3708}
3709
Jeff Leger178b1e52020-10-05 12:22:23 -04003710bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3711 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3712 const VkImageResolve *pRegions) const {
3713 return ValidateCmdResolveImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions,
3714 COPY_COMMAND_VERSION_1);
3715}
3716
3717bool CoreChecks::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3718 const VkResolveImageInfo2KHR *pResolveImageInfo) const {
3719 return ValidateCmdResolveImage(commandBuffer, pResolveImageInfo->srcImage, pResolveImageInfo->srcImageLayout,
3720 pResolveImageInfo->dstImage, pResolveImageInfo->dstImageLayout, pResolveImageInfo->regionCount,
3721 pResolveImageInfo->pRegions, COPY_COMMAND_VERSION_2);
3722}
3723
3724template <typename RegionType>
3725bool CoreChecks::ValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3726 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3727 const RegionType *pRegions, VkFilter filter, CopyCommandVersion version) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003728 const auto *cb_node = GetCBState(commandBuffer);
3729 const auto *src_image_state = GetImageState(srcImage);
3730 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003731
Jeff Leger178b1e52020-10-05 12:22:23 -04003732 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
3733 const char *func_name = is_2khr ? "vkCmdBlitImage2KHR()" : "vkCmdBlitImage()";
3734 const CMD_TYPE cmd_type = is_2khr ? CMD_BLITIMAGE : CMD_BLITIMAGE2KHR;
3735
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003736 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003737 if (cb_node) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003738 skip |= ValidateCmd(cb_node, cmd_type, func_name);
John Zulauf5c2750c2018-01-30 15:04:56 -07003739 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003740 if (cb_node && src_image_state && dst_image_state) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003741 const char *vuid;
3742 const char *location;
3743 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00233" : "VUID-vkCmdBlitImage-srcImage-00233";
3744 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->srcImage" : "vkCmdBlitImage(): srcImage";
3745 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3746 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00234" : "VUID-vkCmdBlitImage-dstImage-00234";
3747 location = is_2khr ? "vkCmdBlitImage2KHR(): pBlitImageInfo->dstImage" : "vkCmdBlitImage(): dstImage";
3748 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
3749 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00220" : "VUID-vkCmdBlitImage-srcImage-00220";
3750 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
3751 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00225" : "VUID-vkCmdBlitImage-dstImage-00225";
3752 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
3753 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00219" : "VUID-vkCmdBlitImage-srcImage-00219";
3754 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
3755 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3756 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00224" : "VUID-vkCmdBlitImage-dstImage-00224";
3757 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
3758 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3759 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdBlitImage-commandBuffer-cmdpool";
3760 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_GRAPHICS_BIT, vuid);
3761 skip |= ValidateCmd(cb_node, cmd_type, func_name);
3762 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-renderpass" : "VUID-vkCmdBlitImage-renderpass";
3763 skip |= InsideRenderPass(cb_node, func_name, vuid);
3764 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01999" : "VUID-vkCmdBlitImage-srcImage-01999";
3765 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, func_name, vuid);
3766 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02000" : "VUID-vkCmdBlitImage-dstImage-02000";
3767 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, func_name, vuid);
3768 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01834" : "VUID-vkCmdBlitImage-commandBuffer-01834";
3769 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
3770 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01835" : "VUID-vkCmdBlitImage-commandBuffer-01835";
3771 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
3772 vuid = is_2khr ? "VUID-vkCmdBlitImage2KHR-commandBuffer-01836" : "VUID-vkCmdBlitImage-commandBuffer-01836";
3773 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
sfricke-samsung022fa252020-07-24 03:26:16 -07003774
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003775 // Validation for VK_EXT_fragment_density_map
3776 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003777 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3778 skip |= LogError(cb_node->commandBuffer, vuid,
3779 "%s: srcImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3780 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003781 }
3782 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003783 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-02545" : "VUID-vkCmdBlitImage-dstImage-02545";
3784 skip |= LogError(cb_node->commandBuffer, vuid,
3785 "%s: dstImage must not have been created with flags containing VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
3786 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02003787 }
3788
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003789 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003790
Dave Houlton33c2d252017-06-09 17:08:32 -06003791 VkFormat src_format = src_image_state->createInfo.format;
3792 VkFormat dst_format = dst_image_state->createInfo.format;
3793 VkImageType src_type = src_image_state->createInfo.imageType;
3794 VkImageType dst_type = dst_image_state->createInfo.imageType;
3795
Cort Stratton186b1a22018-05-01 20:18:06 -04003796 if (VK_FILTER_LINEAR == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003797 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02001" : "VUID-vkCmdBlitImage-filter-02001";
3798 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT, func_name,
3799 vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04003800 } else if (VK_FILTER_CUBIC_IMG == filter) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003801 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-02002" : "VUID-vkCmdBlitImage-filter-02002";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003802 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
Jeff Leger178b1e52020-10-05 12:22:23 -04003803 func_name, vuid);
Dave Houlton33c2d252017-06-09 17:08:32 -06003804 }
3805
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003806 if (FormatRequiresYcbcrConversion(src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003807 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-01561" : "VUID-vkCmdBlitImage-srcImage-01561";
3808 skip |= LogError(device, vuid,
3809 "%s: srcImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003810 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003811 func_name, string_VkFormat(src_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003812 }
3813
3814 if (FormatRequiresYcbcrConversion(dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003815 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-01562" : "VUID-vkCmdBlitImage-dstImage-01562";
3816 skip |= LogError(device, vuid,
3817 "%s: dstImage format (%s) must not be one of the formats requiring sampler YCBCR "
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003818 "conversion for VK_IMAGE_ASPECT_COLOR_BIT image views",
Jeff Leger178b1e52020-10-05 12:22:23 -04003819 func_name, string_VkFormat(dst_format));
Mark Lobodzinski1057e442020-02-13 11:57:15 -07003820 }
3821
Dave Houlton33c2d252017-06-09 17:08:32 -06003822 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003823 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-filter-00237" : "VUID-vkCmdBlitImage-filter-00237";
3824 skip |= LogError(cb_node->commandBuffer, vuid,
3825 "%s: source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.", func_name);
Dave Houlton33c2d252017-06-09 17:08:32 -06003826 }
3827
Dave Houlton33c2d252017-06-09 17:08:32 -06003828 // Validate consistency for unsigned formats
3829 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3830 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003831 ss << func_name << ": If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003832 << "the other one must also have unsigned integer format. "
3833 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003834 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00230" : "VUID-vkCmdBlitImage-srcImage-00230";
3835 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003836 }
3837
3838 // Validate consistency for signed formats
3839 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3840 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003841 ss << func_name << ": If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003842 << "the other one must also have signed integer format. "
3843 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003844 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00229" : "VUID-vkCmdBlitImage-srcImage-00229";
3845 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003846 }
3847
3848 // Validate filter for Depth/Stencil formats
3849 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3850 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003851 ss << func_name << ": If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003852 << "then filter must be VK_FILTER_NEAREST.";
Jeff Leger178b1e52020-10-05 12:22:23 -04003853 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00232" : "VUID-vkCmdBlitImage-srcImage-00232";
3854 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003855 }
3856
3857 // Validate aspect bits and formats for depth/stencil images
3858 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3859 if (src_format != dst_format) {
3860 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003861 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 -06003862 << "stencil, the other one must have exactly the same format. "
3863 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3864 << string_VkFormat(dst_format);
Jeff Leger178b1e52020-10-05 12:22:23 -04003865 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00231" : "VUID-vkCmdBlitImage-srcImage-00231";
3866 skip |= LogError(cb_node->commandBuffer, vuid, "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003867 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003868 } // Depth or Stencil
3869
3870 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003871 const char *invalid_src_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003872 is_2khr ? ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3873 ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-01398"
3874 : "VUID-VkBlitImageInfo2KHR-srcImageLayout-00222")
3875 : ((src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3876 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3877 : "VUID-vkCmdBlitImage-srcImageLayout-00222");
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003878 const char *invalid_dst_layout_vuid =
Jeff Leger178b1e52020-10-05 12:22:23 -04003879 is_2khr ? ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3880 ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-01399"
3881 : "VUID-VkBlitImageInfo2KHR-dstImageLayout-00227")
3882 : ((dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
3883 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3884 : "VUID-vkCmdBlitImage-dstImageLayout-00227");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003885 for (uint32_t i = 0; i < regionCount; i++) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003886 const RegionType rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003887 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04003888 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImageLayout-00221" : "VUID-vkCmdBlitImage-srcImageLayout-00221";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003889 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003890 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, invalid_src_layout_vuid, vuid, &hit_error);
3891 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImageLayout-00226" : "VUID-vkCmdBlitImage-dstImageLayout-00226";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003892 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04003893 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, invalid_dst_layout_vuid, vuid, &hit_error);
3894 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, func_name, "srcSubresource", i);
3895 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, func_name, "dstSubresource", i);
3896 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01705" : "VUID-vkCmdBlitImage-srcSubresource-01705";
3897 skip |=
3898 ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, func_name, "srcSubresource", vuid);
3899 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01706" : "VUID-vkCmdBlitImage-dstSubresource-01706";
3900 skip |=
3901 ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, func_name, "dstSubresource", vuid);
3902 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcSubresource-01707" : "VUID-vkCmdBlitImage-srcSubresource-01707";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003903 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003904 rgn.srcSubresource.layerCount, i, func_name, "srcSubresource", vuid);
3905 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstSubresource-01708" : "VUID-vkCmdBlitImage-dstSubresource-01708";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003906 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04003907 rgn.dstSubresource.layerCount, i, func_name, "dstSubresource", vuid);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003908 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003909 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3910 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003911 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003912 ss << func_name << ": pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003913 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003914 }
Dave Houlton48989f32017-05-26 15:01:46 -06003915 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3916 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003917 std::stringstream ss;
Jeff Leger178b1e52020-10-05 12:22:23 -04003918 ss << func_name << ": pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003919 skip |= LogWarning(cb_node->commandBuffer, kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003920 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003921
3922 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003923 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003924 vuid = is_2khr ? "VUID-VkImageBlit2KHR-layerCount-00239" : "VUID-VkImageBlit-layerCount-00239";
3925 skip |=
3926 LogError(cb_node->commandBuffer, vuid,
3927 "%s: layerCount in source and destination subresource of pRegions[%d] does not match.", func_name, i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003928 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003929
Dave Houlton48989f32017-05-26 15:01:46 -06003930 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003931 vuid = is_2khr ? "VUID-VkImageBlit2KHR-aspectMask-00238" : "VUID-VkImageBlit-aspectMask-00238";
3932 skip |=
3933 LogError(cb_node->commandBuffer, vuid, "%s: aspectMask members for pRegion[%d] do not match.", func_name, i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003934 }
Dave Houlton48989f32017-05-26 15:01:46 -06003935
Dave Houlton33c2d252017-06-09 17:08:32 -06003936 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003937 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00241" : "VUID-vkCmdBlitImage-aspectMask-00241";
3938 skip |= LogError(cb_node->commandBuffer, vuid,
3939 "%s: region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07003940 "image format %s.",
Jeff Leger178b1e52020-10-05 12:22:23 -04003941 func_name, i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003942 }
3943
3944 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003945 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-aspectMask-00242" : "VUID-vkCmdBlitImage-aspectMask-00242";
3946 skip |= LogError(cb_node->commandBuffer, vuid,
3947 "%s: region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3948 func_name, i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003949 }
3950
Dave Houlton48989f32017-05-26 15:01:46 -06003951 // Validate source image offsets
3952 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003953 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003954 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003955 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00245" : "VUID-vkCmdBlitImage-srcImage-00245";
3956 skip |= LogError(cb_node->commandBuffer, vuid,
3957 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3958 "of (%1d, %1d). These must be (0, 1).",
3959 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003960 }
3961 }
3962
Dave Houlton33c2d252017-06-09 17:08:32 -06003963 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003964 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003965 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00247" : "VUID-vkCmdBlitImage-srcImage-00247";
3966 skip |= LogError(cb_node->commandBuffer, vuid,
3967 "%s: region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
3968 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3969 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003970 }
3971 }
3972
Dave Houlton33c2d252017-06-09 17:08:32 -06003973 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003974 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3975 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003976 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003977 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00243" : "VUID-vkCmdBlitImage-srcOffset-00243";
3978 skip |= LogError(cb_node->commandBuffer, vuid,
3979 "%s: region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).",
3980 func_name, i, rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003981 }
3982 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3983 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003984 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003985 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00244" : "VUID-vkCmdBlitImage-srcOffset-00244";
3986 skip |= LogError(cb_node->commandBuffer, vuid,
3987 "%s: region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).",
3988 func_name, i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003989 }
3990 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3991 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003992 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04003993 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcOffset-00246" : "VUID-vkCmdBlitImage-srcOffset-00246";
3994 skip |= LogError(cb_node->commandBuffer, vuid,
3995 "%s: region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).",
3996 func_name, i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003997 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003998 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04003999 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00215" : "VUID-vkCmdBlitImage-pRegions-00215";
4000 skip |= LogError(cb_node->commandBuffer, vuid, "%s: region [%d] source image blit region exceeds image dimensions.",
4001 func_name, i);
Dave Houlton33c2d252017-06-09 17:08:32 -06004002 }
Dave Houlton48989f32017-05-26 15:01:46 -06004003
4004 // Validate dest image offsets
4005 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06004006 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06004007 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004008 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00250" : "VUID-vkCmdBlitImage-dstImage-00250";
4009 skip |= LogError(cb_node->commandBuffer, vuid,
4010 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
4011 "(%1d, %1d). These must be (0, 1).",
4012 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06004013 }
4014 }
4015
Dave Houlton33c2d252017-06-09 17:08:32 -06004016 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06004017 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004018 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstImage-00252" : "VUID-vkCmdBlitImage-dstImage-00252";
4019 skip |= LogError(cb_node->commandBuffer, vuid,
4020 "%s: region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004021 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
Jeff Leger178b1e52020-10-05 12:22:23 -04004022 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06004023 }
4024 }
4025
Dave Houlton33c2d252017-06-09 17:08:32 -06004026 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06004027 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
4028 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004029 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004030 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00248" : "VUID-vkCmdBlitImage-dstOffset-00248";
4031 skip |= LogError(cb_node->commandBuffer, vuid,
4032 "%s: region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).",
4033 func_name, i, rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06004034 }
4035 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
4036 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004037 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004038 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00249" : "VUID-vkCmdBlitImage-dstOffset-00249";
4039 skip |= LogError(cb_node->commandBuffer, vuid,
4040 "%s: region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).",
4041 func_name, i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06004042 }
4043 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
4044 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06004045 oob = true;
Jeff Leger178b1e52020-10-05 12:22:23 -04004046 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-dstOffset-00251" : "VUID-vkCmdBlitImage-dstOffset-00251";
4047 skip |= LogError(cb_node->commandBuffer, vuid,
4048 "%s: region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).",
4049 func_name, i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06004050 }
Cort Strattonff1542a2018-05-27 10:49:28 -07004051 if (oob) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004052 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-pRegions-00216" : "VUID-vkCmdBlitImage-pRegions-00216";
4053 skip |= LogError(cb_node->commandBuffer, vuid,
4054 "%s: region [%d] destination image blit region exceeds image dimensions.", func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004055 }
4056
Dave Houlton33c2d252017-06-09 17:08:32 -06004057 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
4058 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
4059 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04004060 vuid = is_2khr ? "VUID-VkBlitImageInfo2KHR-srcImage-00240" : "VUID-vkCmdBlitImage-srcImage-00240";
4061 skip |= LogError(cb_node->commandBuffer, vuid,
4062 "%s: region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
4063 "layerCount other than 1.",
4064 func_name, i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07004065 }
4066 }
Dave Houlton33c2d252017-06-09 17:08:32 -06004067 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004068 } else {
4069 assert(0);
4070 }
4071 return skip;
4072}
4073
Jeff Leger178b1e52020-10-05 12:22:23 -04004074bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4075 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4076 const VkImageBlit *pRegions, VkFilter filter) const {
4077 return ValidateCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter,
4078 COPY_COMMAND_VERSION_1);
4079}
4080
4081bool CoreChecks::PreCallValidateCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) const {
4082 return ValidateCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4083 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4084 pBlitImageInfo->filter, COPY_COMMAND_VERSION_2);
4085}
4086
4087template <typename RegionType>
4088void CoreChecks::RecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, VkImage dstImage,
4089 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
4090 VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004091 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004092 auto src_image_state = GetImageState(srcImage);
4093 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004094
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004095 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004096 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004097 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
4098 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01004099 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07004100}
4101
Jeff Leger178b1e52020-10-05 12:22:23 -04004102void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4103 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4104 const VkImageBlit *pRegions, VkFilter filter) {
4105 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
4106 pRegions, filter);
4107 RecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount, pRegions, filter);
4108}
4109
4110void CoreChecks::PreCallRecordCmdBlitImage2KHR(VkCommandBuffer commandBuffer, const VkBlitImageInfo2KHR *pBlitImageInfo) {
4111 StateTracker::PreCallRecordCmdBlitImage2KHR(commandBuffer, pBlitImageInfo);
4112 RecordCmdBlitImage(commandBuffer, pBlitImageInfo->srcImage, pBlitImageInfo->srcImageLayout, pBlitImageInfo->dstImage,
4113 pBlitImageInfo->dstImageLayout, pBlitImageInfo->regionCount, pBlitImageInfo->pRegions,
4114 pBlitImageInfo->filter);
4115}
4116
John Zulauf2076e812020-01-08 14:55:54 -07004117GlobalImageLayoutRangeMap *GetLayoutRangeMap(GlobalImageLayoutMap *map, const IMAGE_STATE &image_state) {
4118 assert(map);
4119 // This approach allows for a single hash lookup or/create new
4120 auto inserted = map->emplace(std::make_pair(image_state.image, nullptr));
4121 if (inserted.second) {
4122 assert(nullptr == inserted.first->second.get());
locke-lunarg296a3c92020-03-25 01:04:29 -06004123 GlobalImageLayoutRangeMap *layout_map = new GlobalImageLayoutRangeMap(image_state.subresource_encoder.SubresourceCount());
John Zulauf2076e812020-01-08 14:55:54 -07004124 inserted.first->second.reset(layout_map);
4125 return layout_map;
4126 } else {
4127 assert(nullptr != inserted.first->second.get());
4128 return inserted.first->second.get();
4129 }
4130 return nullptr;
4131}
4132
4133const GlobalImageLayoutRangeMap *GetLayoutRangeMap(const GlobalImageLayoutMap &map, VkImage image) {
4134 auto it = map.find(image);
4135 if (it != map.end()) {
4136 return it->second.get();
4137 }
4138 return nullptr;
4139}
4140
Shannon McPherson449fa9c2018-10-25 11:51:07 -06004141// 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 -07004142bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const GlobalImageLayoutMap &globalImageLayoutMap,
4143 GlobalImageLayoutMap *overlayLayoutMap_arg) const {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -06004144 if (disabled[image_layout_validation]) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004145 bool skip = false;
John Zulauf2076e812020-01-08 14:55:54 -07004146 GlobalImageLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06004147 // Iterate over the layout maps for each referenced image
John Zulauf2076e812020-01-08 14:55:54 -07004148 GlobalImageLayoutRangeMap empty_map(1);
John Zulauff660ad62019-03-23 07:16:05 -06004149 for (const auto &layout_map_entry : pCB->image_layout_map) {
4150 const auto image = layout_map_entry.first;
4151 const auto *image_state = GetImageState(image);
4152 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06004153 const auto &subres_map = layout_map_entry.second;
John Zulauf2076e812020-01-08 14:55:54 -07004154 const auto &initial_layout_map = subres_map->GetInitialLayoutMap();
John Zulauff660ad62019-03-23 07:16:05 -06004155 // Validate the initial_uses for each subresource referenced
John Zulauf2076e812020-01-08 14:55:54 -07004156 if (initial_layout_map.empty()) continue;
4157
4158 auto *overlay_map = GetLayoutRangeMap(&overlayLayoutMap, *image_state);
4159 const auto *global_map = GetLayoutRangeMap(globalImageLayoutMap, image);
4160 if (global_map == nullptr) {
4161 global_map = &empty_map;
4162 }
4163
4164 // Note: don't know if it would matter
4165 // if (global_map->empty() && overlay_map->empty()) // skip this next loop...;
4166
4167 auto pos = initial_layout_map.begin();
4168 const auto end = initial_layout_map.end();
4169 sparse_container::parallel_iterator<const ImageSubresourceLayoutMap::LayoutMap> current_layout(*overlay_map, *global_map,
4170 pos->first.begin);
4171 while (pos != end) {
locke-lunargf155ccf2020-02-18 11:34:15 -07004172 VkImageLayout initial_layout = pos->second;
John Zulauf2076e812020-01-08 14:55:54 -07004173 VkImageLayout image_layout = kInvalidLayout;
John Zulauf2076e812020-01-08 14:55:54 -07004174 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 -07004175 if (current_layout->pos_A->valid) { // pos_A denotes the overlay map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004176 image_layout = current_layout->pos_A->lower_bound->second;
locke-lunargf155ccf2020-02-18 11:34:15 -07004177 } else if (current_layout->pos_B->valid) { // pos_B denotes the global map in the parallel iterator
John Zulauf2076e812020-01-08 14:55:54 -07004178 image_layout = current_layout->pos_B->lower_bound->second;
4179 }
4180 const auto intersected_range = pos->first & current_layout->range;
4181 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
4182 // TODO: Set memory invalid which is in mem_tracker currently
4183 } else if (image_layout != initial_layout) {
4184 // Need to look up the inital layout *state* to get a bit more information
4185 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(pos->first.begin);
4186 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
4187 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
4188 if (!matches) {
John Zulauf2076e812020-01-08 14:55:54 -07004189 // We can report all the errors for the intersected range directly
4190 for (auto index : sparse_container::range_view<decltype(intersected_range)>(intersected_range)) {
locke-lunarg296a3c92020-03-25 01:04:29 -06004191 const auto subresource = image_state->subresource_encoder.Decode(index);
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004192 skip |= LogError(
4193 pCB->commandBuffer, kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06004194 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004195 "to be in layout %s--instead, current layout is %s.",
John Zulauf2076e812020-01-08 14:55:54 -07004196 report_data->FormatHandle(image).c_str(), subresource.aspectMask, subresource.arrayLayer,
Mark Lobodzinski23e395e2020-04-09 10:17:31 -06004197 subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
John Zulaufb61ed972019-04-09 16:12:35 -06004198 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004199 }
4200 }
John Zulauf2076e812020-01-08 14:55:54 -07004201 if (pos->first.includes(intersected_range.end)) {
4202 current_layout.seek(intersected_range.end);
4203 } else {
4204 ++pos;
4205 if (pos != end) {
4206 current_layout.seek(pos->first.begin);
4207 }
4208 }
John Zulauff660ad62019-03-23 07:16:05 -06004209 }
4210
locke-lunargf155ccf2020-02-18 11:34:15 -07004211 // Update all layout set operations (which will be a subset of the initial_layouts)
John Zulauf2076e812020-01-08 14:55:54 -07004212 sparse_container::splice(overlay_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004213 }
John Zulauff660ad62019-03-23 07:16:05 -06004214
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07004215 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07004216}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07004217
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004218void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06004219 for (const auto &layout_map_entry : pCB->image_layout_map) {
4220 const auto image = layout_map_entry.first;
John Zulauf2076e812020-01-08 14:55:54 -07004221 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06004222 const auto *image_state = GetImageState(image);
4223 if (!image_state) continue; // Can't set layouts of a dead image
John Zulauf2076e812020-01-08 14:55:54 -07004224 auto *global_map = GetLayoutRangeMap(&imageLayoutMap, *image_state);
4225 sparse_container::splice(global_map, subres_map->GetCurrentLayoutMap(), sparse_container::value_precedence::prefer_source);
Tony Barbourdf013b92017-01-25 12:53:48 -07004226 }
4227}
4228
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004229// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004230// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
4231// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004232bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
4233 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06004234 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004235 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004236 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
4237
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004238 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
sfricke-samsung55f01952020-03-24 08:16:41 -07004239 // for both loadOp and stencilLoaOp rp2 has it in 1 VU while rp1 has it in 2 VU with half behind Maintenance2 extension
4240 // Each is VUID is below in following order: rp2 -> rp1 with Maintenance2 -> rp1 with no extenstion
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004241 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07004242 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4243 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4244 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004245 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004246 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004247 string_VkImageLayout(first_layout));
sfricke-samsung55f01952020-03-24 08:16:41 -07004248 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4249 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL)) {
4250 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01566",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004251 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004252 string_VkImageLayout(first_layout));
4253 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4254 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004255 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-00836",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004256 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004257 string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004258 }
4259 }
sfricke-samsung55f01952020-03-24 08:16:41 -07004260
4261 // Same as above for loadOp, but for stencilLoadOp
4262 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
4263 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4264 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
4265 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL))) {
4266 skip |= LogError(device, "VUID-VkRenderPassCreateInfo2-pAttachments-02523",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004267 "vkCreateRenderPass2(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004268 string_VkImageLayout(first_layout));
4269 } else if ((use_rp2 == false) && (device_extensions.vk_khr_maintenance2) &&
4270 (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL)) {
4271 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-01567",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004272 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
sfricke-samsung55f01952020-03-24 08:16:41 -07004273 string_VkImageLayout(first_layout));
4274 } else if ((use_rp2 == false) && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
4275 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
4276 skip |= LogError(device, "VUID-VkRenderPassCreateInfo-pAttachments-02511",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004277 "vkCreateRenderPass(): Cannot clear attachment %d with invalid first layout %s.", attachment,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004278 string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02004279 }
4280 }
4281
Mark Lobodzinski552e4402017-02-07 17:14:53 -07004282 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004283}
4284
Mark Lobodzinski96210742017-02-09 10:33:46 -07004285// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4286// is true, verify that (actual & desired) flags == desired
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004287template <typename T1>
4288bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const T1 object,
4289 const VulkanTypedHandle &typed_handle, const char *msgCode, char const *func_name,
4290 char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004291 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004292 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004293 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004294 if (strict) {
4295 correct_usage = ((actual & desired) == desired);
4296 } else {
4297 correct_usage = ((actual & desired) != 0);
4298 }
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004299
Mark Lobodzinski96210742017-02-09 10:33:46 -07004300 if (!correct_usage) {
sfricke-samsungbb971942020-09-10 22:11:56 -07004301 // All callers should have a valid VUID
4302 assert(msgCode != kVUIDUndefined);
4303 skip =
4304 LogError(object, msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4305 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004306 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004307 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004308}
4309
4310// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4311// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004312bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004313 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004314 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, image_state->image,
John Zulauf4fea6622019-04-01 11:38:18 -06004315 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004316}
4317
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004318bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004319 char const *func_name, const char *vuid) const {
Cort Stratton186b1a22018-05-01 20:18:06 -04004320 bool skip = false;
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004321 const VkFormatFeatureFlags image_format_features = image_state->format_features;
4322 if ((image_format_features & desired) != desired) {
4323 // Same error, but more details if it was an AHB external format
4324 if (image_state->has_ahb_format == true) {
4325 skip |= LogError(image_state->image, vuid,
4326 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for the external format "
4327 "found in VkAndroidHardwareBufferFormatPropertiesANDROID::formatFeatures used by %s.",
4328 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004329 report_data->FormatHandle(image_state->image).c_str());
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004330 } else {
4331 skip |= LogError(image_state->image, vuid,
4332 "In %s, VkFormatFeatureFlags (0x%08X) does not support required feature %s for format %u used by %s "
4333 "with tiling %s.",
4334 func_name, image_format_features, string_VkFormatFeatureFlags(desired).c_str(),
4335 image_state->createInfo.format, report_data->FormatHandle(image_state->image).c_str(),
4336 string_VkImageTiling(image_state->createInfo.tiling));
Cort Stratton186b1a22018-05-01 20:18:06 -04004337 }
4338 }
4339 return skip;
4340}
4341
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004342bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004343 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004344 bool skip = false;
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004345 const VkImageAspectFlags apsect_mask = subresource_layers->aspectMask;
Cort Strattond619a302018-05-17 19:46:32 -07004346 // layerCount must not be zero
4347 if (subresource_layers->layerCount == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004348 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-layerCount-01700",
4349 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004350 }
4351 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004352 if (apsect_mask & VK_IMAGE_ASPECT_METADATA_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004353 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00168",
4354 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004355 }
4356 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004357 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 -07004358 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-00167",
4359 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4360 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4361 func_name, i, member);
Cort Strattond619a302018-05-17 19:46:32 -07004362 }
sfricke-samsungfdf91c82020-10-26 03:31:28 -07004363 // aspectMask must not contain VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
4364 if (apsect_mask & (VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT |
4365 VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT | VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
4366 skip |= LogError(cb_node->commandBuffer, "VUID-VkImageSubresourceLayers-aspectMask-02247",
4367 "In %s, pRegions[%u].%s.aspectMask has a VK_IMAGE_ASPECT_MEMORY_PLANE_*_BIT_EXT bit set.", func_name, i,
4368 member);
4369 }
Cort Strattond619a302018-05-17 19:46:32 -07004370 return skip;
4371}
4372
Mark Lobodzinski96210742017-02-09 10:33:46 -07004373// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4374// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004375bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004376 char const *func_name, char const *usage_string) const {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004377 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, buffer_state->buffer,
John Zulauf4fea6622019-04-01 11:38:18 -06004378 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004379}
4380
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004381bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004382 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004383 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004384
4385 const VkDeviceSize &range = pCreateInfo->range;
4386 if (range != VK_WHOLE_SIZE) {
4387 // Range must be greater than 0
4388 if (range <= 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004389 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00928",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004390 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004391 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4392 range);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004393 }
4394 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004395 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4396 if (SafeModulo(range, format_size) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004397 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00929",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004398 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004399 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
4400 "(%" PRIu32 ").",
4401 range, format_size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004402 }
4403 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004404 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004405 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-00930",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004406 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004407 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4408 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4409 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004410 }
4411 // The sum of range and offset must be less than or equal to the size of buffer
4412 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004413 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00931",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004414 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004415 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4416 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4417 range, pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004418 }
janharaldfredriksen-armde71d202020-07-08 12:11:53 +02004419 } else {
4420 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4421
4422 // Size of buffer - offset, divided by the element size of format must be less than or equal to
4423 // VkPhysicalDeviceLimits::maxTexelBufferElements
4424 if (SafeDivision(buffer_state->createInfo.size - pCreateInfo->offset, format_size) >
4425 device_limits->maxTexelBufferElements) {
4426 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-range-04059",
4427 "vkCreateBufferView(): If VkBufferViewCreateInfo range (%" PRIuLEAST64
4428 ") equals VK_WHOLE_SIZE, the buffer's size (%" PRIuLEAST64 ") minus the offset (%" PRIuLEAST64
4429 "), divided by the element size of the format (%" PRIu32
4430 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4431 range, buffer_state->createInfo.size, pCreateInfo->offset, format_size,
4432 device_limits->maxTexelBufferElements);
4433 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004434 }
4435 return skip;
4436}
4437
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004438bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004439 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004440 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004441 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4442 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004443 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00933",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004444 "vkCreateBufferView(): If buffer was created with `usage` containing "
4445 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004446 "be supported for uniform texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004447 }
4448 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4449 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004450 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-00934",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004451 "vkCreateBufferView(): If buffer was created with `usage` containing "
4452 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004453 "be supported for storage texel buffers");
Shannon McPherson265383a2018-06-21 15:37:52 -06004454 }
4455 return skip;
4456}
4457
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004458bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004459 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004460 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004461
Dave Houltond8ed0212018-05-16 17:18:24 -06004462 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004463
Jeff Bolz87697532019-01-11 22:54:00 -06004464 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4465 if (chained_devaddr_struct) {
4466 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4467 chained_devaddr_struct->deviceAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004468 skip |= LogError(device, "VUID-VkBufferCreateInfo-deviceAddress-02604",
4469 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4470 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
Jeff Bolz87697532019-01-11 22:54:00 -06004471 }
4472 }
4473
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004474 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4475 if (chained_opaqueaddr_struct) {
4476 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4477 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004478 skip |= LogError(device, "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4479 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4480 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004481 }
4482 }
4483
Shannon McPherson4984e642019-12-05 13:04:34 -07004484 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz33fc6722020-03-31 12:58:16 -05004485 !enabled_features.core12.bufferDeviceAddressCaptureReplay &&
4486 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004487 skip |= LogError(
4488 device, "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004489 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4490 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4491 }
4492
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004493 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinski314b9162020-07-16 15:33:08 -06004494 skip |= ValidatePhysicalDeviceQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
4495 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices",
4496 "VUID-VkBufferCreateInfo-sharingMode-01419");
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004497 }
4498
sfricke-samsungedce77a2020-07-03 22:35:13 -07004499 if ((pCreateInfo->flags & VK_BUFFER_CREATE_PROTECTED_BIT) != 0) {
4500 if (enabled_features.core11.protectedMemory == VK_FALSE) {
4501 skip |= LogError(device, "VUID-VkBufferCreateInfo-flags-01887",
4502 "vkCreateBuffer(): the protectedMemory device feature is disabled: Buffers cannot be created with the "
4503 "VK_BUFFER_CREATE_PROTECTED_BIT set.");
4504 }
4505 const VkBufferCreateFlags invalid_flags =
4506 VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | VK_BUFFER_CREATE_SPARSE_ALIASED_BIT;
4507 if ((pCreateInfo->flags & invalid_flags) != 0) {
4508 skip |= LogError(device, "VUID-VkBufferCreateInfo-None-01888",
4509 "vkCreateBuffer(): VK_BUFFER_CREATE_PROTECTED_BIT is set so no sparse create flags can be used at "
4510 "same time (VK_BUFFER_CREATE_SPARSE_BINDING_BIT | VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT | "
4511 "VK_BUFFER_CREATE_SPARSE_ALIASED_BIT).");
4512 }
4513 }
4514
Mark Lobodzinski96210742017-02-09 10:33:46 -07004515 return skip;
4516}
4517
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004518bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004519 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004520 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004521 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004522 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4523 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004524 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004525 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4526 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004527 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004528 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4529 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4530 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004531
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004532 // Buffer view offset must be less than the size of buffer
4533 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004534 skip |= LogError(buffer_state->buffer, "VUID-VkBufferViewCreateInfo-offset-00925",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004535 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004536 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4537 pCreateInfo->offset, buffer_state->createInfo.size);
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004538 }
4539
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004540 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004541 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4542 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4543 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
sfricke-samsung9b9c8602020-05-16 01:19:53 -07004544 const char *vuid = device_extensions.vk_ext_texel_buffer_alignment ? "VUID-VkBufferViewCreateInfo-offset-02749"
4545 : "VUID-VkBufferViewCreateInfo-offset-00926";
4546 skip |= LogError(buffer_state->buffer, vuid,
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004547 "vkCreateBufferView(): VkBufferViewCreateInfo offset (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004548 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4549 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
Jeff Bolzd5554e62019-07-19 13:23:52 -05004550 }
4551
4552 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4553 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4554 if ((elementSize % 3) == 0) {
4555 elementSize /= 3;
4556 }
4557 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4558 VkDeviceSize alignmentRequirement =
4559 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4560 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4561 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4562 }
4563 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004564 skip |= LogError(
4565 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02750",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004566 "vkCreateBufferView(): If buffer was created with usage containing "
4567 "VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004568 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4569 ") must be a multiple of the lesser of "
4570 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4571 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4572 "(%" PRId32
4573 ") is VK_TRUE, the size of a texel of the requested format. "
4574 "If the size of a texel is a multiple of three bytes, then the size of a "
4575 "single component of format is used instead",
4576 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4577 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4578 }
4579 }
4580 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4581 VkDeviceSize alignmentRequirement =
4582 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4583 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4584 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4585 }
4586 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004587 skip |= LogError(
4588 buffer_state->buffer, "VUID-VkBufferViewCreateInfo-buffer-02751",
sfricke-samsungf8a3a9b2020-06-12 23:51:51 -07004589 "vkCreateBufferView(): If buffer was created with usage containing "
4590 "VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
Jeff Bolzd5554e62019-07-19 13:23:52 -05004591 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4592 ") must be a multiple of the lesser of "
4593 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4594 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4595 "(%" PRId32
4596 ") is VK_TRUE, the size of a texel of the requested format. "
4597 "If the size of a texel is a multiple of three bytes, then the size of a "
4598 "single component of format is used instead",
4599 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4600 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4601 }
4602 }
4603 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004604
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004605 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004606
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004607 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004608 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004609 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004610}
4611
Mark Lobodzinski602de982017-02-09 11:01:33 -07004612// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004613bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004614 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004615 bool skip = false;
sfricke-samsung79b00482020-04-01 21:15:50 -07004616 const IMAGE_STATE *image_state = GetImageState(image);
4617 // checks color format and (single-plane or non-disjoint)
4618 // if ycbcr extension is not supported then single-plane and non-disjoint are always both true
sfricke-samsung71bc6572020-04-29 15:49:43 -07004619 if ((FormatIsColor(format)) && ((FormatIsMultiplane(format) == false) || (image_state->disjoint == false))) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004620 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004621 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 -07004622 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004623 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 -07004624 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004625 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004626 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004627 skip |= LogError(image, vuid,
4628 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
4629 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4630 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004631 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004632 skip |= LogError(image, vuid,
4633 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
4634 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4635 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004636 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004637 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004638 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004639 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 -07004640 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004641 skip |=
4642 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 -07004643 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004644 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004645 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004646 skip |=
4647 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 -07004648 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004649 skip |= LogError(image, vuid, "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.",
4650 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004651 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004652 } else if (FormatIsMultiplane(format)) {
4653 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4654 if (3 == FormatPlaneCount(format)) {
4655 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4656 }
4657 if ((aspect_mask & valid_flags) != aspect_mask) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004658 skip |=
4659 LogError(image, vuid,
4660 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4661 "set, where n = [0, 1, 2].",
4662 func_name);
Dave Houlton501b15b2018-03-30 15:07:41 -06004663 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004664 }
4665 return skip;
4666}
4667
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004668bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4669 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004670 const char *param_name, const char *image_layer_count_var_name, const VkImage image,
4671 SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004672 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004673
4674 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004675 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004676 skip |= LogError(image, errorCodes.base_mip_err,
4677 "%s: %s.baseMipLevel (= %" PRIu32
4678 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4679 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004680 }
Petr Kraus4d718682017-05-18 03:38:41 +02004681
Petr Krausffa94af2017-08-08 21:46:02 +02004682 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4683 if (subresourceRange.levelCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004684 skip |=
4685 LogError(image, "VUID-VkImageSubresourceRange-levelCount-01720", "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004686 } else {
4687 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004688
Petr Krausffa94af2017-08-08 21:46:02 +02004689 if (necessary_mip_count > image_mip_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004690 skip |= LogError(image, errorCodes.mip_count_err,
4691 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4692 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
4693 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
4694 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004695 }
Petr Kraus4d718682017-05-18 03:38:41 +02004696 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004697 }
Petr Kraus4d718682017-05-18 03:38:41 +02004698
4699 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004700 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004701 skip |= LogError(image, errorCodes.base_layer_err,
4702 "%s: %s.baseArrayLayer (= %" PRIu32
4703 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4704 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004705 }
Petr Kraus4d718682017-05-18 03:38:41 +02004706
Petr Krausffa94af2017-08-08 21:46:02 +02004707 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4708 if (subresourceRange.layerCount == 0) {
sfricke-samsung40b79e32020-05-24 00:27:26 -07004709 skip |=
4710 LogError(image, "VUID-VkImageSubresourceRange-layerCount-01721", "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004711 } else {
4712 const uint64_t necessary_layer_count =
4713 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004714
Petr Krausffa94af2017-08-08 21:46:02 +02004715 if (necessary_layer_count > image_layer_count) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004716 skip |= LogError(image, errorCodes.layer_count_err,
4717 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
4718 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
4719 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
4720 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004721 }
Petr Kraus4d718682017-05-18 03:38:41 +02004722 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004723 }
Petr Kraus4d718682017-05-18 03:38:41 +02004724
Mark Lobodzinski602de982017-02-09 11:01:33 -07004725 return skip;
4726}
4727
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004728bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004729 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004730 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004731 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4732 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4733 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4734
4735 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4736 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4737
4738 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004739 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4740 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004741 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004742 : "VUID-VkImageViewCreateInfo-image-01482")
4743 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4744 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004745 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004746 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4747 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004748
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004749 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004750 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004751 image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004752}
4753
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004754bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004755 const VkImageSubresourceRange &subresourceRange,
4756 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004757 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004758 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4759 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4760 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4761 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004762
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004763 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004764 "vkCmdClearColorImage", param_name, "arrayLayers", image_state->image,
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004765 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004766}
4767
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004768bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004769 const VkImageSubresourceRange &subresourceRange,
4770 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004771 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004772 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4773 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4774 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4775 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004776
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004777 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004778 "vkCmdClearDepthStencilImage", param_name, "arrayLayers", image_state->image,
4779 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004780}
4781
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004782bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004783 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004784 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004785 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004786 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4787 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4788 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4789 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004790
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004791 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004792 cmd_name, param_name, "arrayLayers", image_state->image, subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004793}
4794
Spencer Fricke6bba8c72020-04-06 07:41:21 -07004795bool CoreChecks::ValidateImageViewFormatFeatures(const IMAGE_STATE *image_state, const VkFormat view_format,
4796 const VkImageUsageFlags image_usage) const {
4797 // Pass in image_usage here instead of extracting it from image_state in case there's a chained VkImageViewUsageCreateInfo
4798 bool skip = false;
4799
4800 VkFormatFeatureFlags tiling_features = VK_FORMAT_FEATURE_FLAG_BITS_MAX_ENUM;
4801 const VkImageTiling image_tiling = image_state->createInfo.tiling;
4802
4803 if (image_state->has_ahb_format == true) {
4804 // AHB image view and image share same feature sets
4805 tiling_features = image_state->format_features;
4806 } else if (image_tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
4807 // Parameter validation should catch if this is used without VK_EXT_image_drm_format_modifier
4808 assert(device_extensions.vk_ext_image_drm_format_modifier);
4809 VkImageDrmFormatModifierPropertiesEXT drm_format_properties = {VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_PROPERTIES_EXT,
4810 nullptr};
4811 DispatchGetImageDrmFormatModifierPropertiesEXT(device, image_state->image, &drm_format_properties);
4812
4813 VkFormatProperties2 format_properties_2 = {VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_2, nullptr};
4814 VkDrmFormatModifierPropertiesListEXT drm_properties_list = {VK_STRUCTURE_TYPE_DRM_FORMAT_MODIFIER_PROPERTIES_LIST_EXT,
4815 nullptr};
4816 format_properties_2.pNext = (void *)&drm_properties_list;
4817 DispatchGetPhysicalDeviceFormatProperties2(physical_device, view_format, &format_properties_2);
4818
4819 for (uint32_t i = 0; i < drm_properties_list.drmFormatModifierCount; i++) {
4820 if ((drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifier & drm_format_properties.drmFormatModifier) !=
4821 0) {
4822 tiling_features |= drm_properties_list.pDrmFormatModifierProperties[i].drmFormatModifierTilingFeatures;
4823 }
4824 }
4825 } else {
4826 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
4827 tiling_features = (image_tiling == VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4828 : format_properties.optimalTilingFeatures;
4829 }
4830
4831 if (tiling_features == 0) {
4832 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-None-02273",
4833 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4834 "physical device.",
4835 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4836 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4837 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02274",
4838 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4839 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4840 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4841 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4842 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02275",
4843 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4844 "VK_IMAGE_USAGE_STORAGE_BIT.",
4845 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4846 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4847 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02276",
4848 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4849 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4850 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4851 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4852 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4853 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02277",
4854 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4855 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4856 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4857 } else if ((image_usage & VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT) &&
4858 !(tiling_features & (VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT | VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT))) {
4859 skip |= LogError(image_state->image, "VUID-VkImageViewCreateInfo-usage-02652",
4860 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4861 "VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4862 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4863 }
4864
4865 return skip;
4866}
4867
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004868bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004869 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004870 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004871 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004872 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004873 skip |=
4874 ValidateImageUsageFlags(image_state,
4875 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4876 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
sfricke-samsungbb971942020-09-10 22:11:56 -07004877 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV |
4878 VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4879 false, "VUID-VkImageViewCreateInfo-image-04441", "vkCreateImageView()",
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004880 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
sfricke-samsungbb971942020-09-10 22:11:56 -07004881 "TRANSIENT_ATTACHMENT|SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004882 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004883 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004884 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004885 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004886 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004887 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004888
4889 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4890 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004891 VkImageUsageFlags image_usage = image_state->createInfo.usage;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004892 VkFormat view_format = pCreateInfo->format;
4893 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004894 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004895 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004896
Dave Houltonbd2e2622018-04-10 16:41:14 -06004897 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004898 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004899 if (chained_ivuci_struct) {
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07004900 if (device_extensions.vk_khr_maintenance2) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004901 if (!device_extensions.vk_ext_separate_stencil_usage) {
4902 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004903 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02661",
4904 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4905 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
Andrew Fobel3abeb992020-01-20 16:33:22 -05004906 }
4907 } else {
4908 const auto image_stencil_struct =
4909 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4910 if (image_stencil_struct == nullptr) {
4911 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004912 skip |= LogError(
4913 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02662",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004914 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4915 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4916 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4917 }
4918 } else {
4919 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4920 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4921 image_stencil_struct->stencilUsage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004922 skip |= LogError(
4923 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02663",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004924 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4925 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4926 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4927 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4928 }
4929 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4930 (image_usage | chained_ivuci_struct->usage) != image_usage) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004931 skip |= LogError(
4932 pCreateInfo->image, "VUID-VkImageViewCreateInfo-pNext-02664",
Andrew Fobel3abeb992020-01-20 16:33:22 -05004933 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4934 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4935 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4936 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4937 }
4938 }
4939 }
4940 }
4941
Dave Houltonbd2e2622018-04-10 16:41:14 -06004942 image_usage = chained_ivuci_struct->usage;
4943 }
4944
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004945 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4946 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004947 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004948 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004949 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004950 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004951 std::stringstream ss;
4952 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004953 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004954 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07004955 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01586", "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004956 }
4957 } else {
Nathaniel Cesario0046c312020-10-07 23:28:28 -06004958 if (!(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004959 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4960 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004961 const char *error_vuid;
4962 if ((!device_extensions.vk_khr_maintenance2) && (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4963 error_vuid = "VUID-VkImageViewCreateInfo-image-01018";
4964 } else if ((device_extensions.vk_khr_maintenance2) &&
4965 (!device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4966 error_vuid = "VUID-VkImageViewCreateInfo-image-01759";
4967 } else if ((!device_extensions.vk_khr_maintenance2) &&
4968 (device_extensions.vk_khr_sampler_ycbcr_conversion)) {
4969 error_vuid = "VUID-VkImageViewCreateInfo-image-01760";
4970 } else {
4971 // both enabled
4972 error_vuid = "VUID-VkImageViewCreateInfo-image-01761";
4973 }
Dave Houltonc7988072018-04-16 11:46:56 -06004974 std::stringstream ss;
4975 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004976 << " is not in the same format compatibility class as "
4977 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004978 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4979 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
sfricke-samsung2ff8b6a2020-03-09 21:54:35 -07004980 skip |= LogError(pCreateInfo->image, error_vuid, "%s", ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004981 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004982 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004983 }
4984 } else {
4985 // Format MUST be IDENTICAL to the format the image was created with
Spencer Frickeff160582020-03-16 17:28:14 -07004986 // Unless it is a multi-planar color bit aspect
4987 if ((image_format != view_format) &&
4988 ((FormatIsMultiplane(image_format) == false) || (aspect_mask != VK_IMAGE_ASPECT_COLOR_BIT))) {
4989 const char *vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion) ? "VUID-VkImageViewCreateInfo-image-01762"
4990 : "VUID-VkImageViewCreateInfo-image-01019";
Mark Lobodzinski602de982017-02-09 11:01:33 -07004991 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004992 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004993 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004994 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Spencer Frickeff160582020-03-16 17:28:14 -07004995 skip |= LogError(pCreateInfo->image, vuid, "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004996 }
4997 }
4998
4999 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005000 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06005001
5002 switch (image_type) {
5003 case VK_IMAGE_TYPE_1D:
5004 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005005 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5006 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5007 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005008 }
5009 break;
5010 case VK_IMAGE_TYPE_2D:
5011 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
5012 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
5013 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005014 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01003",
5015 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5016 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005017 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005018 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5019 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5020 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005021 }
5022 }
5023 break;
5024 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005025 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06005026 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
5027 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
5028 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005029 skip |=
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005030 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-01005",
5031 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5032 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005033 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
5034 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005035 skip |= LogError(
5036 pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5037 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
5038 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
5039 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
5040 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005041 }
5042 } else {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005043 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5044 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5045 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005046 }
5047 }
5048 } else {
5049 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005050 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-subResourceRange-01021",
5051 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
5052 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06005053 }
5054 }
5055 break;
5056 default:
5057 break;
5058 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005059
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005060 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005061 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005062 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06005063 }
5064
Spencer Fricke6bba8c72020-04-06 07:41:21 -07005065 skip |= ValidateImageViewFormatFeatures(image_state, view_format, image_usage);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005066
Jeff Bolz9af91c52018-09-01 21:53:57 -05005067 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
5068 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005069 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02086",
5070 "vkCreateImageView() If image was created with usage containing "
5071 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
5072 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005073 }
5074 if (view_format != VK_FORMAT_R8_UINT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005075 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02087",
5076 "vkCreateImageView() If image was created with usage containing "
5077 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
Jeff Bolz9af91c52018-09-01 21:53:57 -05005078 }
5079 }
Jeff Bolz99e3f632020-03-24 22:59:22 -05005080
5081 if (pCreateInfo->subresourceRange.layerCount == VK_REMAINING_ARRAY_LAYERS) {
5082 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE &&
5083 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer != 6) {
5084 skip |= LogError(device, "VUID-VkImageViewCreateInfo-viewType-02962",
5085 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be 6",
5086 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5087 }
5088 if (pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY &&
5089 ((image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer) % 6) != 0) {
5090 skip |= LogError(
5091 device, "VUID-VkImageViewCreateInfo-viewType-02963",
5092 "vkCreateImageView(): subresourceRange.layerCount VK_REMAINING_ARRAY_LAYERS=(%d) must be a multiple of 6",
5093 image_state->createInfo.arrayLayers - pCreateInfo->subresourceRange.baseArrayLayer);
5094 }
5095 }
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005096
5097 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5098 if (pCreateInfo->subresourceRange.levelCount != 1) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005099 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-02571",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005100 "vkCreateImageView(): If image was created with usage containing "
5101 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT, subresourceRange.levelCount (%d) must: be 1",
5102 pCreateInfo->subresourceRange.levelCount);
5103 }
5104 }
5105 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5106 if (!enabled_features.fragment_density_map_features.fragmentDensityMapDynamic) {
Shannon McPhersonafe55122020-05-25 16:20:19 -06005107 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-02572",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005108 "vkCreateImageView(): If the fragmentDensityMapDynamic feature is not enabled, "
5109 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5110 }
5111 } else {
5112 if (image_usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) {
5113 if (image_flags & (VK_IMAGE_CREATE_PROTECTED_BIT | VK_IMAGE_CREATE_SPARSE_BINDING_BIT |
5114 VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT | VK_IMAGE_CREATE_SPARSE_ALIASED_BIT)) {
Shannon McPherson8d0d1f92020-07-06 11:58:21 -06005115 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-04116",
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005116 "vkCreateImageView(): If image was created with usage containing "
5117 "VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT flags must not contain any of "
5118 "VK_IMAGE_CREATE_PROTECTED_BIT, VK_IMAGE_CREATE_SPARSE_BINDING_BIT, "
5119 "VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or VK_IMAGE_CREATE_SPARSE_ALIASED_BIT");
5120 }
5121 }
5122 }
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005123
janharaldfredriksen-arm36e17572020-07-07 13:59:28 +02005124 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT) {
5125 if (!enabled_features.fragment_density_map2_features.fragmentDensityMapDeferred) {
5126 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03567",
5127 "vkCreateImageView(): If the fragmentDensityMapDeferred feature is not enabled, "
5128 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT");
5129 }
5130 if (pCreateInfo->flags & VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT) {
5131 skip |=
5132 LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-flags-03568",
5133 "vkCreateImageView(): If flags contains VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DEFERRED_BIT_EXT, "
5134 "flags must not contain VK_IMAGE_VIEW_CREATE_FRAGMENT_DENSITY_MAP_DYNAMIC_BIT_EXT");
5135 }
5136 }
5137 if (device_extensions.vk_ext_fragment_density_map_2) {
5138 if ((image_flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) && (image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) &&
5139 (pCreateInfo->subresourceRange.layerCount >
5140 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers)) {
5141 skip |= LogError(pCreateInfo->image, "VUID-VkImageViewCreateInfo-image-03569",
5142 "vkCreateImageView(): If image was created with flags containing "
5143 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT and usage containing VK_IMAGE_USAGE_SAMPLED_BIT "
5144 "subresourceRange.layerCount (%d) must: be less than or equal to maxSubsampledArrayLayers (%d)",
5145 pCreateInfo->subresourceRange.layerCount,
5146 phys_dev_ext_props.fragment_density_map2_props.maxSubsampledArrayLayers);
5147 }
5148 }
5149
sfricke-samsung0c4a06f2020-06-27 01:24:32 -07005150 auto astc_decode_mode = lvl_find_in_chain<VkImageViewASTCDecodeModeEXT>(pCreateInfo->pNext);
5151 if ((device_extensions.vk_ext_astc_decode_mode) && (astc_decode_mode != nullptr)) {
5152 if ((enabled_features.astc_decode_features.decodeModeSharedExponent == VK_FALSE) &&
5153 (astc_decode_mode->decodeMode == VK_FORMAT_E5B9G9R9_UFLOAT_PACK32)) {
5154 skip |= LogError(device, "VUID-VkImageViewASTCDecodeModeEXT-decodeMode-02231",
5155 "vkCreateImageView(): decodeModeSharedExponent is not enabled but "
5156 "VkImageViewASTCDecodeModeEXT::decodeMode is VK_FORMAT_E5B9G9R9_UFLOAT_PACK32.");
5157 }
5158 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07005159 }
5160 return skip;
5161}
5162
Jeff Leger178b1e52020-10-05 12:22:23 -04005163template <typename RegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005164bool CoreChecks::ValidateCmdCopyBufferBounds(const BUFFER_STATE *src_buffer_state, const BUFFER_STATE *dst_buffer_state,
Jeff Leger178b1e52020-10-05 12:22:23 -04005165 uint32_t regionCount, const RegionType *pRegions, CopyCommandVersion version) const {
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005166 bool skip = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005167 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5168 const char *func_name = is_2khr ? "vkCmdCopyBuffer2KHR()" : "vkCmdCopyBuffer()";
5169 const char *vuid;
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005170
5171 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
5172 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
5173 VkDeviceSize src_min = UINT64_MAX;
5174 VkDeviceSize src_max = 0;
5175 VkDeviceSize dst_min = UINT64_MAX;
5176 VkDeviceSize dst_max = 0;
5177
5178 for (uint32_t i = 0; i < regionCount; i++) {
5179 src_min = std::min(src_min, pRegions[i].srcOffset);
5180 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
5181 dst_min = std::min(dst_min, pRegions[i].dstOffset);
5182 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
5183
5184 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
5185 if (pRegions[i].srcOffset >= src_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005186 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-srcOffset-00113" : "VUID-vkCmdCopyBuffer-srcOffset-00113";
5187 skip |= LogError(src_buffer_state->buffer, vuid,
5188 "%s: pRegions[%d].srcOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5189 func_name, i, pRegions[i].srcOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005190 }
5191
5192 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
5193 if (pRegions[i].dstOffset >= dst_buffer_size) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005194 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-dstOffset-00114" : "VUID-vkCmdCopyBuffer-dstOffset-00114";
5195 skip |= LogError(dst_buffer_state->buffer, vuid,
5196 "%s: pRegions[%d].dstOffset (%" PRIuLEAST64 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
5197 func_name, i, pRegions[i].dstOffset, i, pRegions[i].size);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005198 }
5199
5200 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
5201 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005202 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00115" : "VUID-vkCmdCopyBuffer-size-00115";
5203 skip |= LogError(src_buffer_state->buffer, vuid,
5204 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the source buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005205 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005206 func_name, i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005207 }
5208
5209 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
5210 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005211 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-size-00116" : "VUID-vkCmdCopyBuffer-size-00116";
5212 skip |= LogError(dst_buffer_state->buffer, vuid,
5213 "%s: pRegions[%d].size (%" PRIuLEAST64 ") is greater than the destination buffer size (%" PRIuLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005214 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
Jeff Leger178b1e52020-10-05 12:22:23 -04005215 func_name, i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005216 }
5217 }
5218
5219 // The union of the source regions, and the union of the destination regions, must not overlap in memory
5220 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
5221 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005222 vuid = is_2khr ? "VUID-VkCopyBufferInfo2KHR-pRegions-00117" : "VUID-vkCmdCopyBuffer-pRegions-00117";
5223 skip |= LogError(src_buffer_state->buffer, vuid, "%s: Detected overlap between source and dest regions in memory.",
5224 func_name);
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06005225 }
5226 }
5227
5228 return skip;
5229}
5230
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005231bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005232 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005233 const auto cb_node = GetCBState(commandBuffer);
5234 const auto src_buffer_state = GetBufferState(srcBuffer);
5235 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005236
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005237 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005238 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
5239 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005240 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06005241 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005242 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
5243 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06005244 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005245 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
5246 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005247 skip |=
5248 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5249 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005250 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
5251 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Jeff Leger178b1e52020-10-05 12:22:23 -04005252 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, regionCount, pRegions, COPY_COMMAND_VERSION_1);
sfricke-samsung022fa252020-07-24 03:26:16 -07005253 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01822");
5254 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01823");
5255 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-commandBuffer-01824");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07005256 return skip;
5257}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07005258
Jeff Leger178b1e52020-10-05 12:22:23 -04005259bool CoreChecks::PreCallValidateCmdCopyBuffer2KHR(VkCommandBuffer commandBuffer,
5260 const VkCopyBufferInfo2KHR *pCopyBufferInfos) const {
5261 const auto cb_node = GetCBState(commandBuffer);
5262 const auto src_buffer_state = GetBufferState(pCopyBufferInfos->srcBuffer);
5263 const auto dst_buffer_state = GetBufferState(pCopyBufferInfos->dstBuffer);
5264
5265 bool skip = false;
5266 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-srcBuffer-00119");
5267 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-VkCopyBufferInfo2KHR-dstBuffer-00121");
5268 // Validate that SRC & DST buffers have correct usage flags set
5269 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
5270 "VUID-VkCopyBufferInfo2KHR-srcBuffer-00118", "vkCmdCopyBuffer2KHR()",
5271 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
5272 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
5273 "VUID-VkCopyBufferInfo2KHR-dstBuffer-00120", "vkCmdCopyBuffer2KHR()",
5274 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
5275 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer2KHR()",
5276 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5277 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-cmdpool");
5278 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER2KHR, "vkCmdCopyBuffer2KHR()");
5279 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-renderpass");
5280 skip |= ValidateCmdCopyBufferBounds(src_buffer_state, dst_buffer_state, pCopyBufferInfos->regionCount,
5281 pCopyBufferInfos->pRegions, COPY_COMMAND_VERSION_2);
5282 skip |=
5283 ValidateProtectedBuffer(cb_node, src_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01822");
5284 skip |=
5285 ValidateProtectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()", "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01823");
5286 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, "vkCmdCopyBuffer2KHR()",
5287 "VUID-vkCmdCopyBuffer2KHR-commandBuffer-01824");
5288 return skip;
5289}
5290
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005291bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005292 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005293 auto buffer_state = GetBufferState(buffer);
sfricke-samsung9c7d8552020-08-16 22:12:21 -07005294 if (buffer_state) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005295 if (buffer_state->in_use.load()) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005296 skip |= LogError(buffer, "VUID-vkDestroyBuffer-buffer-00922", "Cannot free %s that is in use by a command buffer.",
5297 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005298 }
5299 }
5300 return skip;
5301}
5302
Jeff Bolz5c801d12019-10-09 10:38:45 -05005303bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5304 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005305 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005306 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005307
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005308 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005309 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005310 skip |=
5311 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005312 }
5313 return skip;
5314}
5315
Jeff Bolz5c801d12019-10-09 10:38:45 -05005316bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005317 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005318
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005319 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005320 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005321 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005322 }
5323 return skip;
5324}
5325
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005326bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005327 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005328 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005329 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005330 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005331 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005332 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005333 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005334 }
5335 return skip;
5336}
5337
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005338bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005339 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005340 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005341 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005342 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005343 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005344 skip |=
5345 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5346 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005347 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005348 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005349 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5350 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005351 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005352
sfricke-samsung022fa252020-07-24 03:26:16 -07005353 skip |= ValidateProtectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01811");
5354 skip |= ValidateUnprotectedBuffer(cb_node, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-commandBuffer-01812");
5355
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005356 if (dstOffset >= buffer_state->createInfo.size) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005357 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-dstOffset-00024",
5358 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5359 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5360 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005361 }
5362
5363 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005364 skip |= LogError(dstBuffer, "VUID-vkCmdFillBuffer-size-00027",
5365 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5366 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5367 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005368 }
5369
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005370 return skip;
5371}
5372
Jeff Leger178b1e52020-10-05 12:22:23 -04005373template <typename BufferImageCopyRegionType>
sfricke-samsungd0659242020-08-18 22:38:43 -07005374bool CoreChecks::ValidateBufferImageCopyData(const CMD_BUFFER_STATE *cb_node, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005375 const BufferImageCopyRegionType *pRegions, const IMAGE_STATE *image_state,
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005376 const char *function, CopyCommandVersion version, bool image_to_buffer) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005377 bool skip = false;
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005378 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5379 const char *vuid;
Jeff Leger178b1e52020-10-05 12:22:23 -04005380
sfricke-samsung125d2b42020-05-28 06:32:43 -07005381 assert(image_state != nullptr);
5382 const VkFormat image_format = image_state->createInfo.format;
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005383
5384 for (uint32_t i = 0; i < regionCount; i++) {
sfricke-samsung125d2b42020-05-28 06:32:43 -07005385 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005386 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5387 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005388 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00199", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005389 "%s: pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
5390 "and 1, respectively.",
5391 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005392 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005393 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005394
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005395 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5396 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005397 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00201", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005398 "%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 -07005399 "must be 0 and 1, respectively.",
5400 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005401 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005402 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005403
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005404 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5405 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005406 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00213", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005407 "%s: pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005408 "For 3D images these must be 0 and 1, respectively.",
5409 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005410 }
5411 }
5412
5413 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005414 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
sfricke-samsung125d2b42020-05-28 06:32:43 -07005415 uint32_t element_size = FormatElementSize(image_format, region_aspect_mask);
Locke497739c2019-03-08 11:50:47 -07005416
sfricke-samsung125d2b42020-05-28 06:32:43 -07005417 // If not depth/stencil and not multi-plane
5418 if ((!FormatIsDepthAndStencil(image_format) && !FormatIsMultiplane(image_format)) &&
5419 SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005420 vuid = (device_extensions.vk_khr_sampler_ycbcr_conversion)
5421 ? GetBufferImageCopyCommandVUID("01558", image_to_buffer, is_2khr)
5422 : GetBufferImageCopyCommandVUID("00193", image_to_buffer, is_2khr);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005423 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005424 "%s: pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005425 " must be a multiple of this format's texel size (%" PRIu32 ").",
5426 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005427 }
5428
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005429 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5430 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005431 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferRowLength-00195" : "VUID-VkBufferImageCopy-bufferRowLength-00195";
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005432 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005433 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005434 "%s: pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005435 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005436 }
5437
5438 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5439 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005440 vuid =
5441 (is_2khr) ? "VUID-VkBufferImageCopy2KHR-bufferImageHeight-00196" : "VUID-VkBufferImageCopy-bufferImageHeight-00196";
Jeff Leger178b1e52020-10-05 12:22:23 -04005442 skip |=
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005443 LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005444 "%s: pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5445 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005446 }
5447
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005448 // Calculate adjusted image extent, accounting for multiplane image factors
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005449 VkExtent3D adjusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005450 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005451 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 -06005452 ((pRegions[i].imageOffset.x + static_cast<int32_t>(pRegions[i].imageExtent.width)) >
5453 static_cast<int32_t>(adjusted_image_extent.width))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005454 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00197", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005455 "%s: Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005456 "zero or <= image subresource width (%d).",
5457 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005458 adjusted_image_extent.width);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005459 }
5460
5461 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005462 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 -06005463 ((pRegions[i].imageOffset.y + static_cast<int32_t>(pRegions[i].imageExtent.height)) >
5464 static_cast<int32_t>(adjusted_image_extent.height))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005465 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00198", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005466 "%s: Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005467 "zero or <= image subresource height (%d).",
5468 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005469 adjusted_image_extent.height);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005470 }
5471
5472 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005473 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 -06005474 ((pRegions[i].imageOffset.z + static_cast<int32_t>(pRegions[i].imageExtent.depth)) >
5475 static_cast<int32_t>(adjusted_image_extent.depth))) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005476 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00200", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005477 "%s: Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005478 "zero or <= image subresource depth (%d).",
5479 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
Mark Lobodzinski27c824b2020-03-18 11:26:59 -06005480 adjusted_image_extent.depth);
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005481 }
5482
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005483 // subresource aspectMask must have exactly 1 bit set
5484 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
sfricke-samsung125d2b42020-05-28 06:32:43 -07005485 std::bitset<num_bits> aspect_mask_bits(region_aspect_mask);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005486 if (aspect_mask_bits.count() != 1) {
sfricke-samsung03f6ffd2020-10-21 01:12:08 -07005487 vuid = (is_2khr) ? "VUID-VkBufferImageCopy2KHR-aspectMask-00212" : "VUID-VkBufferImageCopy-aspectMask-00212";
5488 skip |= LogError(image_state->image, vuid,
Jeff Leger178b1e52020-10-05 12:22:23 -04005489 "%s: aspectMasks for imageSubresource in pRegion[%d] must have only a single bit set.", function, i);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005490 }
5491
5492 // image subresource aspect bit must match format
sfricke-samsung125d2b42020-05-28 06:32:43 -07005493 if (!VerifyAspectsPresent(region_aspect_mask, image_format)) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005494 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005495 LogError(image_state->image, GetBufferImageCopyCommandVUID("00211", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005496 "%s: pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5497 function, i, region_aspect_mask, image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005498 }
5499
5500 // Checks that apply only to compressed images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005501 if (FormatIsCompressed(image_format) || FormatIsSinglePlane_422(image_format)) {
5502 auto block_size = FormatTexelBlockExtent(image_format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005503
5504 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005505 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005506 skip |=
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005507 LogError(image_state->image, GetBufferImageCopyCommandVUID("00203", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005508 "%s: pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5509 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005510 }
5511
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005512 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005513 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005514 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005515 image_state->image, GetBufferImageCopyCommandVUID("00204", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005516 "%s: pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005517 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005518 }
5519
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005520 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005521 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5522 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5523 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005524 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00205", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005525 "%s: pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005526 "width & height (%d, %d)..",
5527 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width,
5528 block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005529 }
5530
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005531 // bufferOffset must be a multiple of block size (linear bytes)
sfricke-samsung125d2b42020-05-28 06:32:43 -07005532 uint32_t block_size_in_bytes = FormatElementSize(image_format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005533 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005534 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00206", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005535 "%s: pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005536 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
5537 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005538 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005539
5540 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005541 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005542 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005543 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005544 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00207", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005545 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005546 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
5547 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
5548 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005549 }
5550
5551 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005552 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005553 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005554 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00208", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005555 "%s: pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005556 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
5557 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
5558 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005559 }
5560
5561 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005562 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005563 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005564 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("00209", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005565 "%s: pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005566 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
5567 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
5568 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005569 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005570 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005571
5572 // Checks that apply only to multi-planar format images
sfricke-samsung125d2b42020-05-28 06:32:43 -07005573 if (FormatIsMultiplane(image_format)) {
sfricke-samsung552d5e12020-01-07 22:00:20 -08005574 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
sfricke-samsung125d2b42020-05-28 06:32:43 -07005575 if ((FormatPlaneCount(image_format) < 3) && (region_aspect_mask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005576 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005577 "%s: pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005578 "format has three planes.",
5579 function, i);
sfricke-samsung552d5e12020-01-07 22:00:20 -08005580 }
5581
5582 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
sfricke-samsung125d2b42020-05-28 06:32:43 -07005583 if (0 ==
5584 (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 -07005585 skip |= LogError(image_state->image, GetBufferImageCopyCommandVUID("01560", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005586 "%s: pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005587 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5588 function, i);
sfricke-samsung125d2b42020-05-28 06:32:43 -07005589 } else {
5590 // Know aspect mask is valid
5591 const VkFormat compatible_format = FindMultiplaneCompatibleFormat(image_format, region_aspect_mask);
5592 const uint32_t compatible_size = FormatElementSize(compatible_format);
5593 if (SafeModulo(pRegions[i].bufferOffset, compatible_size) != 0) {
5594 skip |= LogError(
sfricke-samsung2e5b16c2020-10-31 22:14:15 -07005595 image_state->image, GetBufferImageCopyCommandVUID("01559", image_to_buffer, is_2khr),
Jeff Leger178b1e52020-10-05 12:22:23 -04005596 "%s: pRegion[%d]->bufferOffset is 0x%" PRIxLEAST64
sfricke-samsung125d2b42020-05-28 06:32:43 -07005597 " but must be a multiple of the multi-plane compatible format's texel size (%u) for plane %u (%s).",
5598 function, i, pRegions[i].bufferOffset, element_size, GetPlaneIndex(region_aspect_mask),
5599 string_VkFormat(compatible_format));
5600 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005601 }
5602 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005603 }
5604
5605 return skip;
5606}
5607
Jeff Leger178b1e52020-10-05 12:22:23 -04005608template <typename BufferImageCopyRegionType>
5609bool CoreChecks::ValidateImageBounds(const IMAGE_STATE *image_state, const uint32_t regionCount,
5610 const BufferImageCopyRegionType *pRegions, const char *func_name, const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005611 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005612 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005613
5614 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005615 VkExtent3D extent = pRegions[i].imageExtent;
5616 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005617
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005618 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5619 {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005620 skip |= LogWarning(image_state->image, kVUID_Core_Image_ZeroAreaSubregion,
5621 "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area", func_name, i, extent.width,
5622 extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005623 }
5624
5625 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5626
5627 // 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 -06005628 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005629 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005630 if (image_extent.width % block_extent.width) {
5631 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5632 }
5633 if (image_extent.height % block_extent.height) {
5634 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5635 }
5636 if (image_extent.depth % block_extent.depth) {
5637 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5638 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005639 }
5640
Dave Houltonfc1a4052017-04-27 14:32:45 -06005641 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005642 skip |= LogError(image_state->image, msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005643 }
5644 }
5645
5646 return skip;
5647}
5648
Jeff Leger178b1e52020-10-05 12:22:23 -04005649template <typename BufferImageCopyRegionType>
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005650bool CoreChecks::ValidateBufferBounds(const IMAGE_STATE *image_state, const BUFFER_STATE *buff_state, uint32_t regionCount,
Jeff Leger178b1e52020-10-05 12:22:23 -04005651 const BufferImageCopyRegionType *pRegions, const char *func_name,
5652 const char *msg_code) const {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005653 bool skip = false;
5654
5655 VkDeviceSize buffer_size = buff_state->createInfo.size;
5656
5657 for (uint32_t i = 0; i < regionCount; i++) {
locke-lunarga19c71d2020-03-02 18:17:04 -07005658 VkDeviceSize max_buffer_offset =
5659 GetBufferSizeFromCopyImage(pRegions[i], image_state->createInfo.format) + pRegions[i].bufferOffset;
5660 if (buffer_size < max_buffer_offset) {
5661 skip |=
5662 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 -07005663 }
5664 }
5665
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005666 return skip;
5667}
5668
Jeff Leger178b1e52020-10-05 12:22:23 -04005669template <typename BufferImageCopyRegionType>
5670bool CoreChecks::ValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5671 VkBuffer dstBuffer, uint32_t regionCount, const BufferImageCopyRegionType *pRegions,
5672 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005673 const auto cb_node = GetCBState(commandBuffer);
5674 const auto src_image_state = GetImageState(srcImage);
5675 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005676
Jeff Leger178b1e52020-10-05 12:22:23 -04005677 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5678 const char *func_name = is_2khr ? "vkCmdCopyImageToBuffer2KHR()" : "vkCmdCopyImageToBuffer()";
5679 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYIMAGETOBUFFER2KHR : CMD_COPYIMAGETOBUFFER;
5680 const char *vuid;
5681
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005682 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, src_image_state, func_name, version, true);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005683
5684 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005685 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005686
5687 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005688 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005689
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005690 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005691
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005692 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005693 vuid =
5694 is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool";
5695 skip |= LogError(cb_node->createInfo.commandPool, vuid,
5696 "Cannot call %s on a command buffer allocated from a pool without graphics, compute, "
5697 "or transfer capabilities.",
5698 func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005699 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005700 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00182" : "VUID-vkCmdCopyImageToBuffer-pRegions-00182";
5701 skip |= ValidateImageBounds(src_image_state, regionCount, pRegions, func_name, vuid);
5702 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-pRegions-00183" : "VUID-vkCmdCopyImageToBuffer-pRegions-00183";
5703 skip |= ValidateBufferBounds(src_image_state, dst_buffer_state, regionCount, pRegions, func_name, vuid);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005704
Jeff Leger178b1e52020-10-05 12:22:23 -04005705 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00188" : "VUID-vkCmdCopyImageToBuffer-srcImage-00188";
5706 const char *location = is_2khr ? "vkCmdCopyImageToBuffer2KHR(): srcImage" : "vkCmdCopyImageToBuffer(): srcImage";
5707 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5708
5709 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00187" : "VUID-vkCmdCopyImageToBuffer-srcImage-00187";
5710 skip |= ValidateMemoryIsBoundToImage(src_image_state, func_name, vuid);
5711 vuid = is_2khr ? "vkCmdCopyImageToBuffer-dstBuffer2KHR-00192" : "vkCmdCopyImageToBuffer dstBuffer-00192";
5712 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, func_name, vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005713
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005714 // Validate that SRC image & DST buffer have correct usage flags set
Jeff Leger178b1e52020-10-05 12:22:23 -04005715 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-00186" : "VUID-vkCmdCopyImageToBuffer-srcImage-00186";
5716 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005717 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005718 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-dstBuffer-00191" : "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191";
5719 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005720 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005721 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01831" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01831";
5722 skip |= ValidateProtectedImage(cb_node, src_image_state, func_name, vuid);
5723 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01832" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01832";
5724 skip |= ValidateProtectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
5725 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer2KHR-commandBuffer-01833" : "VUID-vkCmdCopyImageToBuffer-commandBuffer-01833";
5726 skip |= ValidateUnprotectedBuffer(cb_node, dst_buffer_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005727
5728 // Validation for VK_EXT_fragment_density_map
5729 if (src_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005730 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-02544" : "VUID-vkCmdCopyImageToBuffer-srcImage-02544";
5731 skip |= LogError(cb_node->commandBuffer, vuid,
5732 "%s: srcImage must not have been created with flags containing "
5733 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5734 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005735 }
5736
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005737 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005738 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImage-01998" : "VUID-vkCmdCopyImageToBuffer-srcImage-01998";
5739 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005740 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005741 vuid = is_2khr ? "VUID-vkCmdCopyImageToBuffer-renderpass" : "VUID-vkCmdCopyImageToBuffer-renderpass";
5742 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005743 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005744
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005745 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 -04005746 ? (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-01397"
5747 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397")
5748 : (vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00190"
5749 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190");
5750
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005751 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005752 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5753 vuid =
5754 is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-srcImageLayout-00189" : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005755 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005756 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, func_name, src_invalid_layout_vuid, vuid, &hit_error);
5757 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageOffset-01794" : "VUID-vkCmdCopyImageToBuffer-imageOffset-01794";
5758 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, src_image_state, &pRegions[i], i, func_name, vuid);
5759 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01703"
5760 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703";
5761 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5762 "imageSubresource", vuid);
5763 vuid = is_2khr ? "VUID-VkCopyImageToBufferInfo2KHR-imageSubresource-01704"
5764 : "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005765 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005766 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005767 }
5768 return skip;
5769}
5770
Jeff Leger178b1e52020-10-05 12:22:23 -04005771bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5772 VkBuffer dstBuffer, uint32_t regionCount,
5773 const VkBufferImageCopy *pRegions) const {
5774 return ValidateCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions,
5775 COPY_COMMAND_VERSION_1);
5776}
5777
5778bool CoreChecks::PreCallValidateCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5779 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) const {
5780 return ValidateCmdCopyImageToBuffer(commandBuffer, pCopyImageToBufferInfo->srcImage, pCopyImageToBufferInfo->srcImageLayout,
5781 pCopyImageToBufferInfo->dstBuffer, pCopyImageToBufferInfo->regionCount,
5782 pCopyImageToBufferInfo->pRegions, COPY_COMMAND_VERSION_2);
5783}
5784
John Zulauf1686f232019-07-09 16:27:11 -06005785void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5786 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5787 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5788
5789 auto cb_node = GetCBState(commandBuffer);
5790 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005791 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005792 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005793 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005794 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005795}
5796
Jeff Leger178b1e52020-10-05 12:22:23 -04005797void CoreChecks::PreCallRecordCmdCopyImageToBuffer2KHR(VkCommandBuffer commandBuffer,
5798 const VkCopyImageToBufferInfo2KHR *pCopyImageToBufferInfo) {
5799 StateTracker::PreCallRecordCmdCopyImageToBuffer2KHR(commandBuffer, pCopyImageToBufferInfo);
5800
5801 auto cb_node = GetCBState(commandBuffer);
5802 auto src_image_state = GetImageState(pCopyImageToBufferInfo->srcImage);
5803 // Make sure that all image slices record referenced layout
5804 for (uint32_t i = 0; i < pCopyImageToBufferInfo->regionCount; ++i) {
5805 SetImageInitialLayout(cb_node, *src_image_state, pCopyImageToBufferInfo->pRegions[i].imageSubresource,
5806 pCopyImageToBufferInfo->srcImageLayout);
5807 }
5808}
5809
5810template <typename RegionType>
5811bool CoreChecks::ValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5812 VkImageLayout dstImageLayout, uint32_t regionCount, const RegionType *pRegions,
5813 CopyCommandVersion version) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005814 const auto cb_node = GetCBState(commandBuffer);
5815 const auto src_buffer_state = GetBufferState(srcBuffer);
5816 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005817
Jeff Leger178b1e52020-10-05 12:22:23 -04005818 const bool is_2khr = (version == COPY_COMMAND_VERSION_2);
5819 const char *func_name = is_2khr ? "vkCmdCopyBufferToImage2KHR()" : "vkCmdCopyBufferToImage()";
5820 const CMD_TYPE cmd_type = is_2khr ? CMD_COPYBUFFERTOIMAGE2KHR : CMD_COPYBUFFERTOIMAGE;
5821 const char *vuid;
5822
sfricke-samsung88ac6fe2020-10-24 10:00:13 -07005823 bool skip = ValidateBufferImageCopyData(cb_node, regionCount, pRegions, dst_image_state, func_name, version, false);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005824
5825 // Validate command buffer state
Jeff Leger178b1e52020-10-05 12:22:23 -04005826 skip |= ValidateCmd(cb_node, cmd_type, func_name);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005827
sfricke-samsungea4fd142020-10-17 23:51:59 -07005828 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-cmdpool" : "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool";
5829 skip |= ValidateCmdQueueFlags(cb_node, func_name, VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT, vuid);
5830
Jeff Leger178b1e52020-10-05 12:22:23 -04005831 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00172" : "VUID-vkCmdCopyBufferToImage-pRegions-00172";
5832 skip |= ValidateImageBounds(dst_image_state, regionCount, pRegions, func_name, vuid);
5833 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-pRegions-00171" : "VUID-vkCmdCopyBufferToImage-pRegions-00171";
5834 skip |= ValidateBufferBounds(dst_image_state, src_buffer_state, regionCount, pRegions, func_name, vuid);
5835
5836 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00179" : "VUID-vkCmdCopyBufferToImage-dstImage-00179";
5837 const char *location = is_2khr ? "vkCmdCopyBufferToImage2KHR(): dstImage" : "vkCmdCopyBufferToImage(): dstImage";
5838 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, location, vuid);
5839 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00176" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00176";
5840 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, func_name, vuid);
5841 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00178" : "VUID-vkCmdCopyBufferToImage-dstImage-00178";
5842 skip |= ValidateMemoryIsBoundToImage(dst_image_state, func_name, vuid);
5843 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-srcBuffer-00174" : "VUID-vkCmdCopyBufferToImage-srcBuffer-00174";
5844 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005845 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005846 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-00177" : "VUID-vkCmdCopyBufferToImage-dstImage-00177";
5847 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, vuid, func_name,
Dave Houltond8ed0212018-05-16 17:18:24 -06005848 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Jeff Leger178b1e52020-10-05 12:22:23 -04005849 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01828" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01828";
5850 skip |= ValidateProtectedBuffer(cb_node, src_buffer_state, func_name, vuid);
5851 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-commandBuffer-01829" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01829";
5852 skip |= ValidateProtectedImage(cb_node, dst_image_state, func_name, vuid);
5853 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage-commandBuffer-01830" : "VUID-vkCmdCopyBufferToImage-commandBuffer-01830";
5854 skip |= ValidateUnprotectedImage(cb_node, dst_image_state, func_name, vuid);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005855
5856 // Validation for VK_EXT_fragment_density_map
5857 if (dst_image_state->createInfo.flags & VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005858 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-02543" : "VUID-vkCmdCopyBufferToImage-dstImage-02543";
5859 skip |= LogError(cb_node->commandBuffer, vuid,
5860 "%s: dstImage must not have been created with flags containing "
5861 "VK_IMAGE_CREATE_SUBSAMPLED_BIT_EXT",
5862 func_name);
janharaldfredriksen-arm3b793772020-05-12 18:55:53 +02005863 }
5864
Mark Lobodzinski8c193c02020-02-20 09:20:33 -07005865 if (device_extensions.vk_khr_maintenance1) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005866 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImage-01997" : "VUID-vkCmdCopyBufferToImage-dstImage-01997";
5867 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, func_name, vuid);
Cort Stratton186b1a22018-05-01 20:18:06 -04005868 }
Jeff Leger178b1e52020-10-05 12:22:23 -04005869 vuid = is_2khr ? "VUID-vkCmdCopyBufferToImage2KHR-renderpass" : "VUID-vkCmdCopyBufferToImage-renderpass";
5870 skip |= InsideRenderPass(cb_node, func_name, vuid);
Tobin Ehlisc8266452017-04-07 12:20:30 -06005871 bool hit_error = false;
Jeff Leger178b1e52020-10-05 12:22:23 -04005872
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005873 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 -04005874 ? (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-01396"
5875 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396")
5876 : (is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00181"
5877 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181");
5878
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005879 for (uint32_t i = 0; i < regionCount; ++i) {
Jeff Leger178b1e52020-10-05 12:22:23 -04005880 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, func_name, "imageSubresource", i);
5881 vuid =
5882 is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-dstImageLayout-00180" : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180";
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005883 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Jeff Leger178b1e52020-10-05 12:22:23 -04005884 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, func_name, dst_invalid_layout_vuid, vuid, &hit_error);
5885 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageOffset-01793" : "VUID-vkCmdCopyBufferToImage-imageOffset-01793";
5886 skip |= ValidateCopyBufferImageTransferGranularityRequirements(cb_node, dst_image_state, &pRegions[i], i, func_name, vuid);
5887 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01701"
5888 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01701";
5889 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, func_name,
5890 "imageSubresource", vuid);
5891 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-imageSubresource-01702"
5892 : "VUID-vkCmdCopyBufferToImage-imageSubresource-01702";
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005893 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Jeff Leger178b1e52020-10-05 12:22:23 -04005894 pRegions[i].imageSubresource.layerCount, i, func_name, "imageSubresource", vuid);
sfricke-samsungea4fd142020-10-17 23:51:59 -07005895
5896 // TODO - Don't use ValidateCmdQueueFlags due to currently not having way to add more descriptive message
5897 const COMMAND_POOL_STATE *command_pool = cb_node->command_pool.get();
5898 assert(command_pool != nullptr);
5899 const uint32_t queue_family_index = command_pool->queueFamilyIndex;
5900 const VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[queue_family_index].queueFlags;
5901 const VkImageAspectFlags region_aspect_mask = pRegions[i].imageSubresource.aspectMask;
5902 if (((queue_flags & VK_QUEUE_GRAPHICS_BIT) == 0) &&
5903 ((region_aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0)) {
5904 LogObjectList objlist(cb_node->commandBuffer);
5905 objlist.add(command_pool->commandPool);
5906 vuid = is_2khr ? "VUID-VkCopyBufferToImageInfo2KHR-commandBuffer-04477"
5907 : "VUID-vkCmdCopyBufferToImage-commandBuffer-04477";
5908 skip |= LogError(dst_image_state->image, vuid,
5909 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies VK_IMAGE_ASPECT_DEPTH_BIT or "
5910 "VK_IMAGE_ASPECT_STENCIL_BIT but the command buffer %s was allocated from the command pool %s "
5911 "which was created with queueFamilyIndex %u, which doesn't contain the VK_QUEUE_GRAPHICS_BIT flag.",
5912 func_name, i, region_aspect_mask, report_data->FormatHandle(cb_node->commandBuffer).c_str(),
5913 report_data->FormatHandle(command_pool->commandPool).c_str(), queue_family_index);
5914 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005915 }
5916 return skip;
5917}
5918
Jeff Leger178b1e52020-10-05 12:22:23 -04005919bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5920 VkImageLayout dstImageLayout, uint32_t regionCount,
5921 const VkBufferImageCopy *pRegions) const {
5922 return ValidateCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions,
5923 COPY_COMMAND_VERSION_1);
5924}
5925
5926bool CoreChecks::PreCallValidateCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5927 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo) const {
5928 return ValidateCmdCopyBufferToImage(commandBuffer, pCopyBufferToImageInfo->srcBuffer, pCopyBufferToImageInfo->dstImage,
5929 pCopyBufferToImageInfo->dstImageLayout, pCopyBufferToImageInfo->regionCount,
5930 pCopyBufferToImageInfo->pRegions, COPY_COMMAND_VERSION_2);
5931}
5932
John Zulauf1686f232019-07-09 16:27:11 -06005933void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5934 VkImageLayout dstImageLayout, uint32_t regionCount,
5935 const VkBufferImageCopy *pRegions) {
5936 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5937
5938 auto cb_node = GetCBState(commandBuffer);
5939 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005940 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005941 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005942 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005943 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005944}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005945
Jeff Leger178b1e52020-10-05 12:22:23 -04005946void CoreChecks::PreCallRecordCmdCopyBufferToImage2KHR(VkCommandBuffer commandBuffer,
5947 const VkCopyBufferToImageInfo2KHR *pCopyBufferToImageInfo2KHR) {
5948 StateTracker::PreCallRecordCmdCopyBufferToImage2KHR(commandBuffer, pCopyBufferToImageInfo2KHR);
5949
5950 auto cb_node = GetCBState(commandBuffer);
5951 auto dst_image_state = GetImageState(pCopyBufferToImageInfo2KHR->dstImage);
5952 // Make sure that all image slices are record referenced layout
5953 for (uint32_t i = 0; i < pCopyBufferToImageInfo2KHR->regionCount; ++i) {
5954 SetImageInitialLayout(cb_node, *dst_image_state, pCopyBufferToImageInfo2KHR->pRegions[i].imageSubresource,
5955 pCopyBufferToImageInfo2KHR->dstImageLayout);
5956 }
5957}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005958bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005959 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005960 bool skip = false;
5961 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5962
Dave Houlton1d960ff2018-01-19 12:17:05 -07005963 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005964 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5965 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5966 if (aspect_mask_bits.count() != 1) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005967 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
5968 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005969 }
5970
John Zulaufa26d3c82019-08-14 16:09:08 -06005971 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005972 if (!image_entry) {
5973 return skip;
5974 }
5975
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005976 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5977 if (device_extensions.vk_ext_image_drm_format_modifier) {
5978 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5979 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005980 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-02270",
5981 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5982 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005983 }
5984 } else {
5985 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005986 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-image-00996",
5987 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005988 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005989 }
5990
Dave Houlton1d960ff2018-01-19 12:17:05 -07005991 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005992 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07005993 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5994 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5995 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005996 }
5997
Dave Houlton1d960ff2018-01-19 12:17:05 -07005998 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005999 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006000 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
6001 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
6002 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07006003 }
6004
Dave Houlton1d960ff2018-01-19 12:17:05 -07006005 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07006006 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006007 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
6008 if (FormatIsMultiplane(img_format)) {
6009 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
6010 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
6011 if (FormatPlaneCount(img_format) > 2u) {
6012 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
6013 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
6014 }
6015 if (sub_aspect != (sub_aspect & allowed_flags)) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006016 skip |= LogError(image, vuid,
6017 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
6018 ") must be a single-plane specifier flag.",
6019 sub_aspect);
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006020 }
6021 } else if (FormatIsColor(img_format)) {
6022 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006023 skip |= LogError(image, kVUID_Core_DrawState_InvalidImageAspect,
6024 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
6025 "VK_IMAGE_ASPECT_COLOR.");
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006026 }
6027 } else if (FormatIsDepthOrStencil(img_format)) {
6028 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
6029 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07006030 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06006031 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
6032 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
6033 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
6034 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Mark Lobodzinski4fc2bb42020-01-31 14:21:21 -07006035 skip |= LogError(image, "VUID-vkGetImageSubresourceLayout-tiling-02271",
6036 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
6037 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07006038 }
6039 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006040
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06006041 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07006042 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06006043 }
6044
Mike Weiblen672b58b2017-02-21 14:32:53 -07006045 return skip;
6046}
sfricke-samsung022fa252020-07-24 03:26:16 -07006047
6048// Validates the image is allowed to be protected
6049bool CoreChecks::ValidateProtectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006050 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006051 bool skip = false;
6052 if ((cb_state->unprotected == true) && (image_state->unprotected == false)) {
6053 LogObjectList objlist(cb_state->commandBuffer);
6054 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006055 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 -07006056 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006057 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006058 }
6059 return skip;
6060}
6061
6062// Validates the image is allowed to be unprotected
6063bool CoreChecks::ValidateUnprotectedImage(const CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006064 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006065 bool skip = false;
6066 if ((cb_state->unprotected == false) && (image_state->unprotected == true)) {
6067 LogObjectList objlist(cb_state->commandBuffer);
6068 objlist.add(image_state->image);
locke-lunarg351c9d82020-10-23 14:43:21 -06006069 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 -07006070 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006071 report_data->FormatHandle(image_state->image).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006072 }
6073 return skip;
6074}
6075
6076// Validates the buffer is allowed to be protected
6077bool CoreChecks::ValidateProtectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006078 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006079 bool skip = false;
6080 if ((cb_state->unprotected == true) && (buffer_state->unprotected == false)) {
6081 LogObjectList objlist(cb_state->commandBuffer);
6082 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006083 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 -07006084 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006085 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006086 }
6087 return skip;
6088}
6089
6090// Validates the buffer is allowed to be unprotected
6091bool CoreChecks::ValidateUnprotectedBuffer(const CMD_BUFFER_STATE *cb_state, const BUFFER_STATE *buffer_state, const char *cmd_name,
locke-lunarg351c9d82020-10-23 14:43:21 -06006092 const char *vuid, const char *more_message) const {
sfricke-samsung022fa252020-07-24 03:26:16 -07006093 bool skip = false;
6094 if ((cb_state->unprotected == false) && (buffer_state->unprotected == true)) {
6095 LogObjectList objlist(cb_state->commandBuffer);
6096 objlist.add(buffer_state->buffer);
locke-lunarg351c9d82020-10-23 14:43:21 -06006097 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 -07006098 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
locke-lunarg351c9d82020-10-23 14:43:21 -06006099 report_data->FormatHandle(buffer_state->buffer).c_str(), more_message);
sfricke-samsung022fa252020-07-24 03:26:16 -07006100 }
6101 return skip;
6102}