blob: a3cbf3a3a134fc1a8b8a9ab14d0e8efdc56be6b9 [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
23// Allow use of STL min and max functions in Windows
24#define NOMINMAX
25
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060026#include <cmath>
27#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070028#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020029#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
40#include "shader_validation.h"
41#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070042#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070043
John Zulauff660ad62019-03-23 07:16:05 -060044// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
45static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
46 VkImageSubresourceRange subresource_range;
47 subresource_range.aspectMask = subresource_layers.aspectMask;
48 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
49 subresource_range.layerCount = subresource_layers.layerCount;
50 subresource_range.baseMipLevel = subresource_layers.mipLevel;
51 subresource_range.levelCount = 1;
52 return subresource_range;
53}
54
55IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
56 : image(img),
57 createInfo(*pCreateInfo),
58 valid(false),
59 acquired(false),
60 shared_presentable(false),
61 layout_locked(false),
62 get_sparse_reqs_called(false),
63 sparse_metadata_required(false),
64 sparse_metadata_bound(false),
65 imported_ahb(false),
66 has_ahb_format(false),
67 ahb_format(0),
68 full_range{},
unknown09edc722019-06-21 15:49:38 -060069 create_from_swapchain(VK_NULL_HANDLE),
70 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060071 bind_swapchain_imageIndex(0),
72 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060073 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
74 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
75 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
76 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
77 }
78 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
79 }
80
81 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
82 sparse = true;
83 }
84 const auto format = createInfo.format;
85 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
86 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
87 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
88 } else {
89 init_range.aspectMask =
90 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
91 }
92 full_range = NormalizeSubresourceRange(*this, init_range);
Locked8af3732019-05-10 09:47:56 -060093
sfricke-samsunge2441192019-11-06 14:07:57 -080094 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
95 if (externalMemoryInfo) {
96 external_memory_handle = externalMemoryInfo->handleTypes;
97 }
98
Locked8af3732019-05-10 09:47:56 -060099#ifdef VK_USE_PLATFORM_ANDROID_KHR
100 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
101 if (external_format) {
102 external_format_android = external_format->externalFormat;
103 } else {
104 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
105 external_format_android = 0;
106 }
107#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600108}
109
unknown2c877272019-07-11 12:56:50 -0600110bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
111 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
112 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
113 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
114 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
115 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
116 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
117 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
118}
119
Jeff Bolz82f854d2019-09-17 14:56:47 -0500120// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
121bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
122 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
123 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
124 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
125 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
126 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
127 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
128
129 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
130 createInfo.extent.height <= other_createInfo.extent.height &&
131 createInfo.extent.depth <= other_createInfo.extent.depth &&
132 createInfo.arrayLayers <= other_createInfo.arrayLayers;
133 return is_compatible;
134}
135
unknown2c877272019-07-11 12:56:50 -0600136bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
137 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
138 if ((create_from_swapchain == VK_NULL_HANDLE) && (binding.mem == other_image_state->binding.mem) &&
139 (binding.mem != VK_NULL_HANDLE) && (binding.offset == other_image_state->binding.offset) &&
140 IsCreateInfoEqual(other_image_state->createInfo)) {
141 return true;
142 }
unknowne1661522019-07-11 13:04:18 -0600143 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
144 return true;
145 }
unknown2c877272019-07-11 12:56:50 -0600146 return false;
147}
148
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500149IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
150 : image_view(iv),
151 create_info(*ci),
152 normalized_subresource_range(ci->subresourceRange),
153 samplerConversion(VK_NULL_HANDLE),
154 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600155 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
156 if (conversionInfo) samplerConversion = conversionInfo->conversion;
157 if (image_state) {
158 // A light normalization of the createInfo range
159 auto &sub_res_range = create_info.subresourceRange;
160 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
161 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
162
163 // Cache a full normalization (for "full image/whole image" comparisons)
164 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500165 samples = image_state->createInfo.samples;
166 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600167 }
168}
169
Dave Houltond9611312018-11-19 17:03:36 -0700170uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
171 // uint cast applies floor()
172 return 1u + (uint32_t)log2(std::max({height, width, depth}));
173}
174
175uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
176
177uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
178
John Zulauff660ad62019-03-23 07:16:05 -0600179VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
180 const VkImageCreateInfo &image_create_info = image_state.createInfo;
181 VkImageSubresourceRange norm = range;
182 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
183
184 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
185 // <arrayLayers> can potentially alias.
186 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
187 ? image_create_info.extent.depth
188 : image_create_info.arrayLayers;
189 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
190
191 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
192 VkImageAspectFlags &aspect_mask = norm.aspectMask;
193 if (FormatIsMultiplane(image_create_info.format)) {
194 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
195 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
196 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
197 if (FormatPlaneCount(image_create_info.format) > 2) {
198 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
199 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700200 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700201 }
John Zulauff660ad62019-03-23 07:16:05 -0600202 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700203}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700204
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700206void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700208 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
209 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
210 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
211 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600212 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700213 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
214 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
215 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700216 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700217}
218
219template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700220void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700221 if (imgpair.subresource.aspectMask & aspectMask) {
222 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700223 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700224 }
225}
226
Tony Barbourdf013b92017-01-25 12:53:48 -0700227// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600228void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700229 auto it = imageLayoutMap.find(imgpair);
230 if (it != imageLayoutMap.end()) {
231 it->second.layout = layout; // Update
232 } else {
233 imageLayoutMap[imgpair].layout = layout; // Insert
234 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700235}
236
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700237bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700238 if (!(imgpair.subresource.aspectMask & aspectMask)) {
239 return false;
240 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700241 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
242 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600243 auto imgsubIt = imageLayoutMap.find(imgpair);
244 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700245 return false;
246 }
247 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200248 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(imgpair.image),
Dave Houlton51653902018-06-22 17:32:13 -0600249 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600250 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700251 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700252 string_VkImageLayout(imgsubIt->second.layout));
253 }
254 layout = imgsubIt->second.layout;
255 return true;
256}
257
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700258// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700259bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700260 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700261 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
262 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
263 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
264 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600265 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700266 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
267 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
268 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700269 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700270 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
271 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600272 auto imgsubIt = imageLayoutMap.find(imgpair);
273 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700274 layout = imgsubIt->second.layout;
275 }
276 return true;
277}
278
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500279bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600280 auto sub_data = imageSubresourceMap.find(image);
281 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700282 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 if (!image_state) return false;
284 bool ignoreGlobal = false;
285 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
286 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
287 ignoreGlobal = true;
288 }
289 for (auto imgsubpair : sub_data->second) {
290 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600291 auto img_data = imageLayoutMap.find(imgsubpair);
292 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700293 layouts.push_back(img_data->second.layout);
294 }
295 }
296 return true;
297}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700298
John Zulauf3b04ebd2019-07-18 14:08:11 -0600299bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
300 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700301 if (!(imgpair.subresource.aspectMask & aspectMask)) {
302 return false;
303 }
304 imgpair.subresource.aspectMask = aspectMask;
305 auto imgsubIt = imageLayoutMap.find(imgpair);
306 if (imgsubIt == imageLayoutMap.end()) {
307 return false;
308 }
309 layout = imgsubIt->second.layout;
310 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700311}
Tony Barbourdf013b92017-01-25 12:53:48 -0700312
313// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600314bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
315 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700316 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
317 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
318 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
319 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
320 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600321 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700322 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
323 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
324 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
325 }
326 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700327 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
328 imgpair = {imgpair.image, false, VkImageSubresource()};
329 auto imgsubIt = imageLayoutMap.find(imgpair);
330 if (imgsubIt == imageLayoutMap.end()) return false;
331 layout = imgsubIt->second.layout;
332 }
333 return true;
334}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700335
336// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700337void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700338 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600339 auto data = imageLayoutMap.find(imgpair);
340 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700341 data->second.layout = layout; // Update
342 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600343 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700344 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600345 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700346 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
347 if (subresource == image_subresources.end()) {
348 image_subresources.push_back(imgpair);
349 }
350}
351
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600352// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600353void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600354 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
355 VkImageLayout expected_layout) {
356 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
357 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600358 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600359 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700360 }
361}
John Zulauff660ad62019-03-23 07:16:05 -0600362
363// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600364void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500365 if (disabled.image_layout_validation) {
366 return;
367 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500368 IMAGE_STATE *image_state = view_state.image_state.get();
369 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
370 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600371}
372
373// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600374void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600375 const VkImageSubresourceRange &range, VkImageLayout layout) {
376 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
377 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600378 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600379}
380
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600381void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600382 VkImageLayout layout) {
383 const IMAGE_STATE *image_state = GetImageState(image);
384 if (!image_state) return;
385 SetImageInitialLayout(cb_node, *image_state, range, layout);
386};
387
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600388void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600389 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
390 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600391}
Dave Houltonddd65c52018-05-08 14:58:01 -0600392
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600393// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700394void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
395 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500396 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600397
John Zulauff660ad62019-03-23 07:16:05 -0600398 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600399 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
400 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600401 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 -0600402 sub_range.baseArrayLayer = 0;
403 sub_range.layerCount = image_state->createInfo.extent.depth;
404 }
405
Piers Daniell4fde9b72019-11-27 16:19:46 -0700406 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
407 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
408 SetImageLayout(cb_node, *image_state, sub_range, layout);
409 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
410 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
411 } else {
412 SetImageLayout(cb_node, *image_state, sub_range, layout);
413 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600414}
415
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700416bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
417 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700418 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600419 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700421 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100422 const char *vuid;
423 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
424
425 if (!image_state) {
426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
427 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600428 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700429 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
430 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100431 return skip;
432 }
433
434 auto image_usage = image_state->createInfo.usage;
435
436 // Check for layouts that mismatch image usages in the framebuffer
437 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800438 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439 skip |=
440 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600441 "Layout/usage mismatch for attachment %u in %s"
442 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100443 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600444 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
445 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100446 }
447
448 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
449 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800450 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451 skip |=
452 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600453 "Layout/usage mismatch for attachment %u in %s"
454 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600456 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
457 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100458 }
459
460 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800461 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100462 skip |=
463 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600464 "Layout/usage mismatch for attachment %u in %s"
465 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600467 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
468 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100469 }
470
471 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800472 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100473 skip |=
474 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600475 "Layout/usage mismatch for attachment %u in %s"
476 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100477 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600478 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
479 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100480 }
481
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600482 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100483 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
484 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
485 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
486 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
487 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800488 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700489 skip |= log_msg(
490 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600491 "Layout/usage mismatch for attachment %u in %s"
492 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700493 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600494 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
495 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100496 }
497 } else {
498 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
499 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
500 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
501 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
502 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
503 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600504 "Layout/usage mismatch for attachment %u in %s"
505 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100506 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600507 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
508 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700509 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100510 }
511 }
512 return skip;
513}
514
John Zulauf17a01bb2019-08-09 16:41:19 -0600515bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700516 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600517 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600518 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700519 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700520 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100521 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700523 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100524 auto framebuffer = framebuffer_state->framebuffer;
525
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700526 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600527 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -0600528 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700529 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700530 }
John Zulauf8e308292018-09-21 11:34:37 -0600531
Tobias Hectorc9057422019-07-23 12:15:52 +0100532 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
533 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
534 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100535 }
536
Tobias Hectorc9057422019-07-23 12:15:52 +0100537 if (attachments != nullptr) {
538 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
539 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
540 auto image_view = attachments[i];
541 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100542
Tobias Hectorc9057422019-07-23 12:15:52 +0100543 if (!view_state) {
544 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
545 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
546 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
547 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
548 report_data->FormatHandle(image_view).c_str());
549 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100550 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100551
552 const VkImage image = view_state->create_info.image;
553 const IMAGE_STATE *image_state = GetImageState(image);
554
555 if (!image_state) {
556 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
557 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
558 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
559 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
560 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
561 continue;
562 }
563 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
564 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
565
Piers Daniell7f894f62020-01-09 16:33:48 -0700566 // Default to expecting stencil in the same layout.
567 auto attachment_stencil_initial_layout = attachment_initial_layout;
568
569 // If a separate layout is specified, look for that.
570 const auto *attachment_description_stencil_layout =
571 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
572 if (attachment_description_stencil_layout) {
573 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
574 }
575
Tobias Hectorc9057422019-07-23 12:15:52 +0100576 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
577 // in common with the non-const version.)
578 const ImageSubresourceLayoutMap *subresource_map =
579 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
580
581 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
582 LayoutUseCheckAndMessage layout_check(subresource_map);
583 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700584 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
585 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
586 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700587
John Zulauf5e617452019-11-19 14:44:16 -0700588 // Allow for differing depth and stencil layouts
589 VkImageLayout check_layout = attachment_initial_layout;
590 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
591
592 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Piers Daniell7f894f62020-01-09 16:33:48 -0700593 subres_skip |= log_msg(
594 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
595 kVUID_Core_DrawState_InvalidRenderpass,
596 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
597 "and the %s layout of the attachment is %s. The layouts must match, or the render "
598 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700599 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100600 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700601 }
John Zulauf5e617452019-11-19 14:44:16 -0700602
Tobias Hectorc9057422019-07-23 12:15:52 +0100603 skip |= subres_skip;
604 }
605
606 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
607 framebuffer, render_pass, i, "initial layout");
608
609 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
610 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100611 }
612
Tobias Hectorc9057422019-07-23 12:15:52 +0100613 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
614 auto &subpass = pRenderPassInfo->pSubpasses[j];
615 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
616 auto &attachment_ref = subpass.pInputAttachments[k];
617 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
618 auto image_view = attachments[attachment_ref.attachment];
619 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100620
Tobias Hectorc9057422019-07-23 12:15:52 +0100621 if (view_state) {
622 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700623 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
624 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100625 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100626 }
627 }
628 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100629
Tobias Hectorc9057422019-07-23 12:15:52 +0100630 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
631 auto &attachment_ref = subpass.pColorAttachments[k];
632 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
633 auto image_view = attachments[attachment_ref.attachment];
634 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100635
Tobias Hectorc9057422019-07-23 12:15:52 +0100636 if (view_state) {
637 auto image = view_state->create_info.image;
638 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
639 framebuffer, render_pass, attachment_ref.attachment,
640 "color attachment layout");
641 if (subpass.pResolveAttachments) {
642 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
643 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
644 attachment_ref.attachment, "resolve attachment layout");
645 }
646 }
647 }
648 }
649
650 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
651 auto &attachment_ref = *subpass.pDepthStencilAttachment;
652 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
653 auto image_view = attachments[attachment_ref.attachment];
654 auto view_state = GetImageViewState(image_view);
655
656 if (view_state) {
657 auto image = view_state->create_info.image;
658 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
659 framebuffer, render_pass, attachment_ref.attachment,
660 "input attachment layout");
661 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100662 }
663 }
664 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700665 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600666 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700667}
668
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600669void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700670 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700671 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700672 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600673 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700674 VkImageLayout stencil_layout = kInvalidLayout;
675 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
676 if (attachment_reference_stencil_layout) {
677 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
678 }
679
680 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600681 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700682 }
683}
684
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600685void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
686 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700687 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700688
689 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700690 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700691 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700692 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700693 }
694 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700695 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700696 }
697 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700698 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700699 }
700 }
701}
702
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700703// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
704// 1. Transition into initialLayout state
705// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600706void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700707 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700708 // First transition into initialLayout
709 auto const rpci = render_pass_state->createInfo.ptr();
710 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700711 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600712 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700713 VkImageLayout stencil_layout = kInvalidLayout;
714 const auto *attachment_description_stencil_layout =
715 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
716 if (attachment_description_stencil_layout) {
717 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
718 }
719
720 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600721 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700722 }
723 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700724 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700725}
726
Dave Houlton10b39482017-03-16 13:18:15 -0600727bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600728 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600729 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600730 }
731 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600732 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600733 }
734 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600735 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600736 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700737 if (0 !=
738 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
739 if (FormatPlaneCount(format) == 1) return false;
740 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600741 return true;
742}
743
Mike Weiblen62d08a32017-03-07 22:18:27 -0700744// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200745bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
746 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600747 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200749 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600750 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700751
752 switch (layout) {
753 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
754 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600755 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700756 }
757 break;
758 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
759 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600760 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700761 }
762 break;
763 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
764 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600765 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 }
767 break;
768 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
769 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600770 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700771 }
772 break;
773 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
774 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600775 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700776 }
777 break;
778 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
779 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600780 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700781 }
782 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600783 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500784 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
785 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
786 }
787 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700788 default:
789 // Other VkImageLayout values do not have VUs defined in this context.
790 break;
791 }
792
Dave Houlton8e9f6542018-05-18 12:18:22 -0600793 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600794 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200795 HandleToUint64(img_barrier.image), msg_code,
796 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
797 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
798 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700799 }
800 return skip;
801}
802
803// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600804bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
805 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700806 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700807
Petr Krausad0096a2019-08-09 18:35:04 +0200808 // Scoreboard for checking for duplicate and inconsistent barriers to images
809 struct ImageBarrierScoreboardEntry {
810 uint32_t index;
811 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
812 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
813 const VkImageMemoryBarrier *barrier;
814 };
815 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
816 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
817
John Zulauf463c51e2018-05-31 13:29:20 -0600818 // Scoreboard for duplicate layout transition barriers within the list
819 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
820 ImageBarrierScoreboardImageMap layout_transitions;
821
Mike Weiblen62d08a32017-03-07 22:18:27 -0700822 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200823 const auto &img_barrier = pImageMemoryBarriers[i];
824 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700825
John Zulauf463c51e2018-05-31 13:29:20 -0600826 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
827 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
828 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200829 if (img_barrier.oldLayout != img_barrier.newLayout) {
830 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
831 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600832 if (image_it != layout_transitions.end()) {
833 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200834 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600835 if (subres_it != subres_map.end()) {
836 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200837 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
838 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
839 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600840 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700841 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
842 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200843 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600844 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
845 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200846 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
847 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
848 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600849 }
850 entry = new_entry;
851 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200852 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600853 }
854 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200855 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600856 }
857 }
858
Petr Krausad0096a2019-08-09 18:35:04 +0200859 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600860 if (image_state) {
861 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200862 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
863 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600864
865 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
866 if (image_state->layout_locked) {
867 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600868 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700869 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200870 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600871 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600872 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Krausad0096a2019-08-09 18:35:04 +0200873 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
874 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600875 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600876
John Zulaufa4472282019-08-22 14:44:34 -0600877 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600878 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600879 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200880 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700881 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600882 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
883 skip |=
884 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
885 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03319",
886 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600887 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200888 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600889 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600890 }
891 } else {
892 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
893 if ((aspect_mask & ds_mask) != (ds_mask)) {
894 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
895 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03320",
896 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
897 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
898 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
899 string_VkFormat(image_create_info.format), aspect_mask);
900 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700901 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700902 }
John Zulauff660ad62019-03-23 07:16:05 -0600903
Petr Krausad0096a2019-08-09 18:35:04 +0200904 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
905 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600906 // TODO: Set memory invalid which is in mem_tracker currently
907 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
908 // subresource.
909 } else if (subresource_map) {
910 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600911 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200912 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700913 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
914 const auto &value = *pos;
915 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
916 subres_skip = log_msg(
917 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
918 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
919 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
920 "%s layout is %s.",
921 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
922 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
923 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600924 }
John Zulauf5e617452019-11-19 14:44:16 -0700925 }
John Zulauff660ad62019-03-23 07:16:05 -0600926 skip |= subres_skip;
927 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700928 }
929 }
930 return skip;
931}
932
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600933bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200934 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700935
Jeff Bolz6835fda2019-10-06 00:15:34 -0500936 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200937 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700938}
939
John Zulauf6b4aae82018-05-09 13:03:36 -0600940template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600941bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
942 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600943 using BarrierRecord = QFOTransferBarrier<Barrier>;
944 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500945 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600946 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
947 const char *barrier_name = BarrierRecord::BarrierName();
948 const char *handle_name = BarrierRecord::HandleName();
949 const char *transfer_type = nullptr;
950 for (uint32_t b = 0; b < barrier_count; b++) {
951 if (!IsTransferOp(&barriers[b])) continue;
952 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700953 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600954 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600955 const auto found = barrier_sets.release.find(barriers[b]);
956 if (found != barrier_sets.release.cend()) {
957 barrier_record = &(*found);
958 transfer_type = "releasing";
959 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600960 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600961 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 const auto found = barrier_sets.acquire.find(barriers[b]);
963 if (found != barrier_sets.acquire.cend()) {
964 barrier_record = &(*found);
965 transfer_type = "acquiring";
966 }
967 }
968 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700969 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
970 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
971 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
972 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
973 func_name, barrier_name, b, transfer_type, handle_name,
974 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
975 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600976 }
977 }
978 return skip;
979}
980
John Zulaufa4472282019-08-22 14:44:34 -0600981VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
982 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
983}
984
985const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
986 return device_state.GetImageState(barrier.image);
987}
988
989VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
990 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
991}
992
993const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
994 return device_state.GetBufferState(barrier.buffer);
995}
996
997VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
998
John Zulauf6b4aae82018-05-09 13:03:36 -0600999template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001000void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1001 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001002 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001003 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1004 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001005 auto &barrier = barriers[b];
1006 if (IsTransferOp(&barrier)) {
1007 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
1008 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
1009 barrier_sets.release.emplace(barrier);
1010 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
1011 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1012 barrier_sets.acquire.emplace(barrier);
1013 }
1014 }
1015
1016 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1017 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1018 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1019 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1020 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1021 auto handle_state = BarrierHandleState(*this, barrier);
1022 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1023 if (!mode_concurrent) {
1024 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001025 cb_state->queue_submit_functions.emplace_back(
1026 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1027 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1028 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1029 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001030 });
1031 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001032 }
1033 }
1034}
1035
John Zulaufa4472282019-08-22 14:44:34 -06001036bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001037 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001038 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001039 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001040 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001041 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1042 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001043 return skip;
1044}
1045
John Zulaufa4472282019-08-22 14:44:34 -06001046void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1047 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1048 const VkImageMemoryBarrier *pImageMemBarriers) {
1049 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1050 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001051}
1052
1053template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001054bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001055 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001056 // Record to the scoreboard or report that we have a duplication
1057 bool skip = false;
1058 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1059 if (!inserted.second && inserted.first->second != cb_state) {
1060 // This is a duplication (but don't report duplicates from the same CB, as we do that at record time
Lockee9aeebf2019-03-03 23:50:08 -07001061 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1062 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1063 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -06001064 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -07001065 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1066 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001067 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 }
1069 return skip;
1070}
1071
1072template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001073bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1074 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001075 using BarrierRecord = QFOTransferBarrier<Barrier>;
1076 using TypeTag = typename BarrierRecord::Tag;
1077 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001078 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001079 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001080 const char *barrier_name = BarrierRecord::BarrierName();
1081 const char *handle_name = BarrierRecord::HandleName();
1082 // No release should have an extant duplicate (WARNING)
1083 for (const auto &release : cb_barriers.release) {
1084 // Check the global pending release barriers
1085 const auto set_it = global_release_barriers.find(release.handle);
1086 if (set_it != global_release_barriers.cend()) {
1087 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1088 const auto found = set_for_handle.find(release);
1089 if (found != set_for_handle.cend()) {
1090 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1091 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001092 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001093 " to dstQueueFamilyIndex %" PRIu32
1094 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001095 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001096 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1097 }
1098 }
1099 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1100 }
1101 // Each acquire must have a matching release (ERROR)
1102 for (const auto &acquire : cb_barriers.acquire) {
1103 const auto set_it = global_release_barriers.find(acquire.handle);
1104 bool matching_release_found = false;
1105 if (set_it != global_release_barriers.cend()) {
1106 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1107 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1108 }
1109 if (!matching_release_found) {
1110 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1111 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001112 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1113 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1114 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001115 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1116 }
1117 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1118 }
1119 return skip;
1120}
1121
John Zulauf3b04ebd2019-07-18 14:08:11 -06001122bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001123 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001124 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001125 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001126 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1127 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001128 return skip;
1129}
1130
1131template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001132void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001133 using BarrierRecord = QFOTransferBarrier<Barrier>;
1134 using TypeTag = typename BarrierRecord::Tag;
1135 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001136 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001137
1138 // Add release barriers from this submit to the global map
1139 for (const auto &release : cb_barriers.release) {
1140 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1141 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1142 global_release_barriers[release.handle].insert(release);
1143 }
1144
1145 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1146 for (const auto &acquire : cb_barriers.acquire) {
1147 // NOTE: We're not using [] because we don't want to create entries for missing releases
1148 auto set_it = global_release_barriers.find(acquire.handle);
1149 if (set_it != global_release_barriers.end()) {
1150 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1151 set_for_handle.erase(acquire);
1152 if (set_for_handle.size() == 0) { // Clean up empty sets
1153 global_release_barriers.erase(set_it);
1154 }
1155 }
1156 }
1157}
1158
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001159void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001160 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1161 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001162}
1163
John Zulauf6b4aae82018-05-09 13:03:36 -06001164// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001165void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001166
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001167void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001168 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001169 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001170 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001171
Chris Forbes4de4b132017-08-21 11:27:08 -07001172 // For ownership transfers, the barrier is specified twice; as a release
1173 // operation on the yielding queue family, and as an acquire operation
1174 // on the acquiring queue family. This barrier may also include a layout
1175 // transition, which occurs 'between' the two operations. For validation
1176 // purposes it doesn't seem important which side performs the layout
1177 // transition, but it must not be performed twice. We'll arbitrarily
1178 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001179 //
1180 // However, we still need to record initial layout for the "initial layout" validation
1181 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001182
Petr Krausad0096a2019-08-09 18:35:04 +02001183 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001184 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001185 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001186 for (const auto &image : image_state->aliasing_images) {
1187 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001188 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001189 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001190 }
1191}
1192
unknown86bcb3a2019-07-11 13:05:36 -06001193void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001194 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001195 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1196 const auto &image_create_info = image_state->createInfo;
1197
1198 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1199 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1200 // for all (potential) layer sub_resources.
1201 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1202 normalized_isr.baseArrayLayer = 0;
1203 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1204 }
1205
John Zulauf2be3fe02019-12-30 09:48:02 -07001206 if (is_release_op) {
1207 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1208 } else {
1209 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1210 }
unknown86bcb3a2019-07-11 13:05:36 -06001211}
1212
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001213bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1214 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1215 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1216 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001217 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001218 assert(cb_node);
1219 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001220 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001221 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001222
John Zulauff660ad62019-03-23 07:16:05 -06001223 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1224 if (subresource_map) {
1225 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001226 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001227 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1228 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001229 *error = true;
John Zulauf5e617452019-11-19 14:44:16 -07001230 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1231 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1232 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1233 "%s layout %s.",
1234 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1235 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1236 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001237 }
John Zulauf5e617452019-11-19 14:44:16 -07001238 }
John Zulauff660ad62019-03-23 07:16:05 -06001239 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001240 }
John Zulauff660ad62019-03-23 07:16:05 -06001241
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001242 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1243 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1244 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001245 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1246 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001247 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001248 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001249 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001250 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001251 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001252 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001253 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001254 if (image_state->shared_presentable) {
1255 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001256 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1257 layout_invalid_msg_code,
1258 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1259 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001260 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001261 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001262 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001263 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001264 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton7df30962018-05-17 19:45:57 -07001265 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001266 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001267 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1268 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001269 }
1270 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001271 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001272}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001273bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001274 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1275 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001276 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001277 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1278 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1279}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001280
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001281void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001282 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001283 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001284 if (!renderPass) return;
1285
Tobias Hectorbbb12282018-10-22 15:17:59 +01001286 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001287 if (framebuffer_state) {
1288 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001289 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001290 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001291 VkImageLayout stencil_layout = kInvalidLayout;
1292 const auto *attachment_description_stencil_layout =
1293 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1294 if (attachment_description_stencil_layout) {
1295 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1296 }
1297
1298 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001299 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001300 }
1301 }
1302}
Dave Houltone19e20d2018-02-02 16:32:41 -07001303
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304#ifdef VK_USE_PLATFORM_ANDROID_KHR
1305// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1306// This could also move into a seperate core_validation_android.cpp file... ?
1307
1308//
1309// AHB-specific validation within non-AHB APIs
1310//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001311bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001312 bool skip = false;
1313
1314 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1315 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001316 if (0 != ext_fmt_android->externalFormat) {
1317 if (VK_FORMAT_UNDEFINED != create_info->format) {
1318 skip |=
1319 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1320 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001321 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001322 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1323 }
1324
1325 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1326 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1327 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001328 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001329 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1330 }
1331
1332 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1333 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1334 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001335 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001336 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1337 }
1338
1339 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1340 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1341 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001342 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001343 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1344 }
1345 }
1346
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001347 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1349 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001350 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001351 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1352 }
1353 }
1354
Dave Houltond9611312018-11-19 17:03:36 -07001355 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001356 if (VK_FORMAT_UNDEFINED == create_info->format) {
1357 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1358 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001359 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001360 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1361 }
1362 }
1363
1364 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1365 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1366 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001367 skip |=
1368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1369 "VUID-VkImageCreateInfo-pNext-02393",
1370 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1371 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1372 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001373 }
1374
1375 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1377 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001378 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001379 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1380 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1381 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1382 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001383 }
1384
1385 return skip;
1386}
1387
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001388bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001389 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001390 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001391
1392 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001393 if (VK_FORMAT_UNDEFINED != create_info->format) {
1394 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1395 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1396 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1397 "format member is %s.",
1398 string_VkFormat(create_info->format));
1399 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001400
Dave Houltond9611312018-11-19 17:03:36 -07001401 // Chain must include a compatible ycbcr conversion
1402 bool conv_found = false;
1403 uint64_t external_format = 0;
1404 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1405 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001406 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001407 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001408 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001409 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001410 }
Dave Houltond9611312018-11-19 17:03:36 -07001411 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001412 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond9611312018-11-19 17:03:36 -07001414 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1415 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1416 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1417 }
1418
1419 // Errors in create_info swizzles
1420 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1421 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1422 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1423 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1425 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1426 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1427 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001428 }
1429 }
Dave Houltond9611312018-11-19 17:03:36 -07001430
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001431 return skip;
1432}
1433
John Zulaufa26d3c82019-08-14 16:09:08 -06001434bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001435 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001436
John Zulaufa26d3c82019-08-14 16:09:08 -06001437 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001438 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1439 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1440 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001441 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001442 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1443 "bound to memory.");
1444 }
1445 return skip;
1446}
1447
1448#else
1449
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001450bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001451 return false;
1452}
1453
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001454bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001455
John Zulaufa26d3c82019-08-14 16:09:08 -06001456bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001457
1458#endif // VK_USE_PLATFORM_ANDROID_KHR
1459
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001460bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001461 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001462 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001463
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001464 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001465 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001466 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1467 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1468 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1469 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001470 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001471 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001472 }
1473
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001474 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1475 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1476 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1477 "VUID-VkImageCreateInfo-flags-00949",
1478 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1479 "flag bit is set");
1480 }
1481
1482 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1483 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1484 "VUID-VkImageCreateInfo-imageType-00954",
1485 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1486 "height (%d) and arrayLayers (%d) must be >= 6.",
1487 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1488 }
Dave Houlton130c0212018-01-29 13:39:56 -07001489 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001490
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001491 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001492 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1493 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1494 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001496 "VUID-VkImageCreateInfo-usage-00964",
1497 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1498 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001499 }
1500
1501 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001502 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001503 "VUID-VkImageCreateInfo-usage-00965",
1504 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1505 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001506 }
1507
ByumjinConffx991b6062019-08-14 15:17:53 -07001508 if (device_extensions.vk_ext_fragment_density_map) {
1509 uint32_t ceiling_width =
1510 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1511 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1512 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1513 skip |=
1514 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1515 "VUID-VkImageCreateInfo-usage-02559",
1516 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1517 "ceiling of device "
1518 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1519 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1520 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1521 }
1522
1523 uint32_t ceiling_height =
1524 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1525 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1526 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1527 skip |=
1528 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1529 "VUID-VkImageCreateInfo-usage-02560",
1530 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1531 "ceiling of device "
1532 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1533 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1534 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1535 }
1536 }
1537
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001538 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001539 VkResult result = VK_SUCCESS;
1540 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1541 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1542 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1543 &format_limits);
1544 } else {
1545 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1546 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1547 image_format_info.type = pCreateInfo->imageType;
1548 image_format_info.tiling = pCreateInfo->tiling;
1549 image_format_info.usage = pCreateInfo->usage;
1550 image_format_info.flags = pCreateInfo->flags;
1551 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1552 format_limits = image_format_properties.imageFormatProperties;
1553 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001554
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001555 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001556#ifdef VK_USE_PLATFORM_ANDROID_KHR
1557 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1558#endif // VK_USE_PLATFORM_ANDROID_KHR
1559 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1560 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1561 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001562 } else {
1563 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1564 const char *format_string = string_VkFormat(pCreateInfo->format);
1565 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1566 "VUID-VkImageCreateInfo-mipLevels-02255",
1567 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1568 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1569 }
Dave Houlton130c0212018-01-29 13:39:56 -07001570
Dave Houltona585d132019-01-18 13:05:42 -07001571 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1572 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1573 (uint64_t)pCreateInfo->samples;
1574 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001575
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001576 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001577 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001578 uint64_t ig_mask = imageGranularity - 1;
1579 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001580
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001581 if (total_size > format_limits.maxResourceSize) {
1582 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1583 kVUID_Core_Image_InvalidFormatLimitsViolation,
1584 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1585 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1586 total_size, format_limits.maxResourceSize);
1587 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001588
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001589 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1590 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1591 "VUID-VkImageCreateInfo-arrayLayers-02256",
1592 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1593 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1594 }
1595
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001596 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1597 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001598 skip |= log_msg(
1599 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1600 "VUID-VkImageCreateInfo-format-02653",
1601 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1602 pCreateInfo->arrayLayers);
1603 }
1604
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001605 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1606 skip |=
1607 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1608 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001609 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001610 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001611 }
1612
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001613 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001614 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton12befb92018-06-26 17:16:46 -06001615 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001616 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1617 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001618 }
1619
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001620 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001621 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1622 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1623 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1624 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001625 skip |=
1626 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1627 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1628 "format must be block, ETC or ASTC compressed, but is %s",
1629 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001630 }
1631 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1632 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001633 skip |=
1634 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1635 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1636 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001637 }
1638 }
1639 }
1640
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001641 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001642 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1643 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1644 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001645 }
1646
unknown2c877272019-07-11 12:56:50 -06001647 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1648 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1649 skip |=
1650 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1651 "VUID-VkImageCreateInfo-format-01577",
1652 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1653 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1654 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001655 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001656}
1657
John Zulauf7eeb6f72019-06-17 11:56:36 -06001658void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1659 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1660 if (VK_SUCCESS != result) return;
1661
1662 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1663
1664 IMAGE_LAYOUT_STATE image_state;
1665 image_state.layout = pCreateInfo->initialLayout;
1666 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001667 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001668 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001669 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001670}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001671
Jeff Bolz5c801d12019-10-09 10:38:45 -05001672bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001673 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001674 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001675 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001676 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001677 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001678 }
1679 return skip;
1680}
1681
John Zulauf7eeb6f72019-06-17 11:56:36 -06001682void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1683 // Clean up validation specific data
1684 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001685
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001686 const auto &sub_entry = imageSubresourceMap.find(image);
1687 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001688 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001689 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001690 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001691 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001692 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001693
1694 // Clean up generic image state
1695 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001696}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001697
John Zulauf07288512019-07-05 11:09:50 -06001698bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001699 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001700
1701 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1702 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001704 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001705 }
1706
Dave Houlton1d2022c2017-03-29 11:43:58 -06001707 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001708 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1709 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001710 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001711 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001712 char const str[] = "vkCmdClearColorImage called with compressed image.";
1713 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001714 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001715 }
1716
1717 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1718 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1719 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001720 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001721 }
1722 return skip;
1723}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001725uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1726 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1727 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001728 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001729 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001730 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001731 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001732}
1733
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001734uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1735 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1736 uint32_t array_layer_count = range->layerCount;
1737 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1738 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001739 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001740 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001741}
1742
John Zulauf07288512019-07-05 11:09:50 -06001743bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1744 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1745 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001746 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001747 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1748 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001750 HandleToUint64(image_state->image), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001751 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1752 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001754
1755 } else {
1756 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1757 if (!device_extensions.vk_khr_shared_presentable_image) {
1758 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
1759 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1760 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-00005",
1761 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1762 string_VkImageLayout(dest_image_layout));
1763 }
1764 } else {
1765 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1766 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
1767 skip |= log_msg(
1768 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1769 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-01394",
1770 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1771 func_name, string_VkImageLayout(dest_image_layout));
1772 }
1773 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001774 }
1775
John Zulauff660ad62019-03-23 07:16:05 -06001776 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001777 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001778 if (subresource_map) {
1779 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001780 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001781 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001782 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1783 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001784 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1785 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1786 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1787 } else {
1788 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001789 }
John Zulauff660ad62019-03-23 07:16:05 -06001790 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1791 HandleToUint64(cb_node->commandBuffer), error_code,
1792 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1793 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1794 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001795 }
John Zulauf5e617452019-11-19 14:44:16 -07001796 }
John Zulauff660ad62019-03-23 07:16:05 -06001797 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001798 }
1799
1800 return skip;
1801}
1802
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001803bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1804 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001805 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001806 bool skip = false;
1807 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001808 const auto *cb_node = GetCBState(commandBuffer);
1809 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001810 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001811 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001812 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001813 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001814 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001815 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001816 skip |=
1817 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1818 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001819 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001820 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001821 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001822 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001823 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001824 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1825 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001826 }
1827 }
1828 return skip;
1829}
1830
John Zulaufeabb4462019-07-05 14:13:03 -06001831void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1832 const VkClearColorValue *pColor, uint32_t rangeCount,
1833 const VkImageSubresourceRange *pRanges) {
1834 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1835
1836 auto cb_node = GetCBState(commandBuffer);
1837 auto image_state = GetImageState(image);
1838 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001839 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001840 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001841 }
1842 }
1843}
1844
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001845bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1846 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001847 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001848 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001849
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001850 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001851 const auto *cb_node = GetCBState(commandBuffer);
1852 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001853 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001854 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001855 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001856 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001857 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001858 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001859 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001860 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1861 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001862 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001863 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001864 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001865 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001866 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001867 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001868 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001869 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001870 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1871 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001872 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001873 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1874 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001875 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001876 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001877 }
1878 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001879 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001880 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001881 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001882 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001883 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001884 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1885 char const str[] =
1886 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1887 "set.";
1888 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001889 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001890 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001891 }
1892 return skip;
1893}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001894
John Zulaufeabb4462019-07-05 14:13:03 -06001895void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1896 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1897 const VkImageSubresourceRange *pRanges) {
1898 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1899 auto cb_node = GetCBState(commandBuffer);
1900 auto image_state = GetImageState(image);
1901 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001902 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001903 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001904 }
1905 }
1906}
1907
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001908// Returns true if [x, xoffset] and [y, yoffset] overlap
1909static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1910 bool result = false;
1911 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1912 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1913
1914 if (intersection_max > intersection_min) {
1915 result = true;
1916 }
1917 return result;
1918}
1919
Dave Houltonc991cc92018-03-06 11:08:51 -07001920// Returns true if source area of first copy region intersects dest area of second region
1921// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1922static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001923 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001924
Dave Houltonc991cc92018-03-06 11:08:51 -07001925 // Separate planes within a multiplane image cannot intersect
1926 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001927 return result;
1928 }
1929
Dave Houltonc991cc92018-03-06 11:08:51 -07001930 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1931 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1932 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001933 result = true;
1934 switch (type) {
1935 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001936 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001937 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001938 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001939 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001940 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001941 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001942 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001943 break;
1944 default:
1945 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1946 assert(false);
1947 }
1948 }
1949 return result;
1950}
1951
Dave Houltonfc1a4052017-04-27 14:32:45 -06001952// Returns non-zero if offset and extent exceed image extents
1953static const uint32_t x_bit = 1;
1954static const uint32_t y_bit = 2;
1955static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001956static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001957 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001958 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001959 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1960 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001961 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001962 }
1963 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1964 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001965 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001966 }
1967 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1968 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001969 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001970 }
1971 return result;
1972}
1973
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001974// Test if two VkExtent3D structs are equivalent
1975static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1976 bool result = true;
1977 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1978 (extent->depth != other_extent->depth)) {
1979 result = false;
1980 }
1981 return result;
1982}
1983
Dave Houltonee281a52017-12-08 13:51:02 -07001984// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1985// Destination image texel extents must be adjusted by block size for the dest validation checks
1986VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1987 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001988 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1989 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001990 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001991 adjusted_extent.width /= block_size.width;
1992 adjusted_extent.height /= block_size.height;
1993 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001994 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1995 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001996 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001997 adjusted_extent.width *= block_size.width;
1998 adjusted_extent.height *= block_size.height;
1999 adjusted_extent.depth *= block_size.depth;
2000 }
2001 return adjusted_extent;
2002}
2003
Dave Houlton6f9059e2017-05-02 17:15:13 -06002004// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002005static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2006 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002007
2008 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002009 if (mip >= img->createInfo.mipLevels) {
2010 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002011 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002012
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002013 // Don't allow mip adjustment to create 0 dim, but pass along a 0 if that's what subresource specified
Dave Houltonfc1a4052017-04-27 14:32:45 -06002014 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002015
Dave Houltone48cd112019-01-03 17:01:18 -07002016 // If multi-plane, adjust per-plane extent
2017 if (FormatIsMultiplane(img->createInfo.format)) {
2018 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2019 extent.width /= divisors.width;
2020 extent.height /= divisors.height;
2021 }
2022
Jeff Bolzef40fec2018-09-01 22:04:34 -05002023 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2024 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002025 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002026 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2027 } else {
2028 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2029 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2030 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2031 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002032
Dave Houlton6f9059e2017-05-02 17:15:13 -06002033 // Image arrays have an effective z extent that isn't diminished by mip level
2034 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002035 extent.depth = img->createInfo.arrayLayers;
2036 }
2037
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002038 return extent;
2039}
2040
2041// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002042static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002043 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2044}
2045
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002046// Test if the extent argument has any dimensions set to 0.
2047static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2048 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2049}
2050
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002051// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002052VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002053 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2054 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002055 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002056 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002057 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002058 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002059 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002060 granularity.width *= block_size.width;
2061 granularity.height *= block_size.height;
2062 }
2063 }
2064 return granularity;
2065}
2066
2067// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2068static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2069 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002070 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2071 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072 valid = false;
2073 }
2074 return valid;
2075}
2076
2077// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002078bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002079 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002080 bool skip = false;
2081 VkExtent3D offset_extent = {};
2082 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2083 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2084 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002085 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002086 // 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 -07002087 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002088 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002089 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002090 "%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 "
2091 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002092 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093 }
2094 } else {
2095 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2096 // integer multiples of the image transfer granularity.
2097 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002098 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002099 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002100 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2101 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002102 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2103 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002104 }
2105 }
2106 return skip;
2107}
2108
2109// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002110bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002111 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002112 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002114 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002115 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2116 // subresource extent.
2117 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002118 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002119 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002120 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2121 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2122 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2123 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002124 }
2125 } else {
2126 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2127 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2128 // subresource extent dimensions.
2129 VkExtent3D offset_extent_sum = {};
2130 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2131 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2132 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002133 bool x_ok = true;
2134 bool y_ok = true;
2135 bool z_ok = true;
2136 switch (image_type) {
2137 case VK_IMAGE_TYPE_3D:
2138 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2139 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002140 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002141 case VK_IMAGE_TYPE_2D:
2142 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2143 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002144 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002145 case VK_IMAGE_TYPE_1D:
2146 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2147 (subresource_extent->width == offset_extent_sum.width));
2148 break;
2149 default:
2150 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2151 assert(false);
2152 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002153 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002154 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002155 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002156 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2157 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2158 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2159 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2160 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2161 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002162 }
2163 }
2164 return skip;
2165}
2166
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002167bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002168 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002169 bool skip = false;
2170 if (mip_level >= img->createInfo.mipLevels) {
2171 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2172 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002173 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2174 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002175 }
2176 return skip;
2177}
2178
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002179bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002180 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002181 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002182 bool skip = false;
2183 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2184 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2185 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2186 HandleToUint64(cb_node->commandBuffer), vuid,
2187 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002188 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002189 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2190 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002191 }
2192 return skip;
2193}
2194
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002195// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002196bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002197 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002198 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002199 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002200 VkExtent3D granularity = GetScaledItg(cb_node, img);
2201 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002202 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002203 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002204 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002205 return skip;
2206}
2207
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002208// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002209bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002210 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002211 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002212 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002213 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002214 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2215 skip |=
2216 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002218 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002219 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2220 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002221
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002222 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002223 granularity = GetScaledItg(cb_node, dst_img);
2224 skip |=
2225 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002226 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002227 const VkExtent3D dest_effective_extent =
2228 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002230 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002231 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002232 return skip;
2233}
2234
Dave Houlton6f9059e2017-05-02 17:15:13 -06002235// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002236bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002237 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002238 bool skip = false;
2239
2240 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002241 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002242
2243 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002244 const VkExtent3D src_copy_extent = region.extent;
2245 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002246 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2247
Dave Houlton6f9059e2017-05-02 17:15:13 -06002248 bool slice_override = false;
2249 uint32_t depth_slices = 0;
2250
2251 // Special case for copying between a 1D/2D array and a 3D image
2252 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2253 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002254 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 slice_override = (depth_slices != 1);
2256 } 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 -07002257 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 slice_override = (depth_slices != 1);
2259 }
2260
2261 // Do all checks on source image
2262 //
2263 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002264 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002266 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002267 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002268 "be 0 and 1, respectively.",
2269 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 }
2271 }
2272
Dave Houlton533be9f2018-03-26 17:08:30 -06002273 // VUID-VkImageCopy-srcImage-01785
2274 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002276 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002277 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002278 "these must be 0 and 1, respectively.",
2279 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002280 }
2281
Dave Houlton533be9f2018-03-26 17:08:30 -06002282 // VUID-VkImageCopy-srcImage-01787
2283 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2284 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002285 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002286 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2287 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002288 }
2289
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002290 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002291 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002292 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293 skip |=
2294 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002295 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002296 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002297 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2298 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002299 }
2300 }
2301 } else { // Pre maint 1
2302 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002303 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002304 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002305 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002306 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2307 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002308 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2309 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002310 }
2311 }
2312 }
2313
Dave Houltonc991cc92018-03-06 11:08:51 -07002314 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002315 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002316 if (FormatIsCompressed(src_state->createInfo.format) ||
2317 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002318 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002319 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002320 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2321 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2322 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002323 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002325 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002326 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002327 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002328 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002329 }
2330
Dave Houlton94a00372017-12-14 15:08:47 -07002331 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002332 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2333 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002334 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002335 skip |=
2336 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002337 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002338 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002339 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002340 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 }
2342
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002343 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002344 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2345 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002346 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002347 skip |=
2348 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002349 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002350 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002351 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002352 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002353 }
2354
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002355 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002356 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2357 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002358 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002359 skip |=
2360 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002361 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002362 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002363 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002364 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002365 }
2366 } // Compressed
2367
2368 // Do all checks on dest image
2369 //
2370 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002371 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002372 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002373 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002374 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002375 "these must be 0 and 1, respectively.",
2376 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002377 }
2378 }
2379
Dave Houlton533be9f2018-03-26 17:08:30 -06002380 // VUID-VkImageCopy-dstImage-01786
2381 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002383 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002384 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d and extent.depth is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002385 "and 1, respectively.",
2386 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002387 }
2388
2389 // VUID-VkImageCopy-dstImage-01788
2390 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2391 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002392 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002393 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2394 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 }
2396
2397 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002398 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002400 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002401 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002402 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2403 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002404 }
2405 }
2406 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002407 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002408 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002409 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002410 skip |=
2411 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002412 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002413 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002414 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2415 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002416 }
2417 }
2418 } else { // Pre maint 1
2419 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002420 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002421 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002422 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002423 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2424 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002425 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2426 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002427 }
2428 }
2429 }
2430
Dave Houltonc991cc92018-03-06 11:08:51 -07002431 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2432 if (FormatIsCompressed(dst_state->createInfo.format) ||
2433 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002434 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002435
2436 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002437 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2438 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2439 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002440 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002442 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002443 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002444 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002445 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002446 }
2447
Dave Houlton94a00372017-12-14 15:08:47 -07002448 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002449 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2450 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002451 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002452 skip |=
2453 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002454 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002455 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002456 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002457 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002458 }
2459
Dave Houltonee281a52017-12-08 13:51:02 -07002460 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2461 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2462 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002463 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002464 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002465 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002466 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2467 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002468 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002469 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002470 }
2471
Dave Houltonee281a52017-12-08 13:51:02 -07002472 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2473 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2474 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002475 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002476 skip |=
2477 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002478 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002479 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002480 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002481 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 }
2483 } // Compressed
2484 }
2485 return skip;
2486}
2487
Dave Houltonc991cc92018-03-06 11:08:51 -07002488// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002489bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002490 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002491 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002492
2493 // Neither image is multiplane
2494 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2495 // If neither image is multi-plane the aspectMask member of src and dst must match
2496 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2497 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002498 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002499 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002501 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002502 }
2503 } else {
2504 // Source image multiplane checks
2505 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2506 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2507 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2508 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002509 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002510 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002511 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002512 }
2513 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2514 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2515 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002516 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002517 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002518 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002519 }
2520 // Single-plane to multi-plane
2521 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2522 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2523 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002524 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002526 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002527 }
2528
2529 // Dest image multiplane checks
2530 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2531 aspect = region.dstSubresource.aspectMask;
2532 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2533 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002534 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002536 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002537 }
2538 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2539 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2540 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002541 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002543 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002544 }
2545 // Multi-plane to single-plane
2546 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2547 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2548 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002549 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002550 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002551 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002552 }
2553 }
2554
2555 return skip;
2556}
2557
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002558bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2559 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002560 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002561 const auto *cb_node = GetCBState(commandBuffer);
2562 const auto *src_image_state = GetImageState(srcImage);
2563 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002564 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002565
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002566 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002568 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2569
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002570 for (uint32_t i = 0; i < regionCount; i++) {
2571 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002572
2573 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2574 VkExtent3D src_copy_extent = region.extent;
2575 VkExtent3D dst_copy_extent =
2576 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2577
Dave Houlton6f9059e2017-05-02 17:15:13 -06002578 bool slice_override = false;
2579 uint32_t depth_slices = 0;
2580
2581 // Special case for copying between a 1D/2D array and a 3D image
2582 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2583 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2584 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002585 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002586 slice_override = (depth_slices != 1);
2587 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2588 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002589 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002590 slice_override = (depth_slices != 1);
2591 }
2592
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002593 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2594 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2595 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002596 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002597 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002598 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002599 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002600 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2601 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002602 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002603 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2604 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002605
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002606 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002607 // No chance of mismatch if we're overriding depth slice count
2608 if (!slice_override) {
2609 // The number of depth slices in srcSubresource and dstSubresource must match
2610 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2611 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002612 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2613 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002614 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002615 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2616 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002617 if (src_slices != dst_slices) {
2618 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002619 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002620 << "] do not match";
2621 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002622 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002623 }
2624 }
2625 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002626 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002627 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002628 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002629 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002630 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002631 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002632 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002633 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002634 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002635
Dave Houltonc991cc92018-03-06 11:08:51 -07002636 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002637 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002638 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002639 }
2640
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002641 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002642 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2643 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002644 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002645 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002646 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002647 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002648 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002649
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002650 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002651 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002652 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002653 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002654 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2655 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002656 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002657 }
2658
2659 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002660 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002661 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002662 ss << "vkCmdCopyImage(): pRegion[" << i
2663 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002664 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002665 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002666 }
2667
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002668 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2669 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2670 // The source region specified by a given element of regions must be a region that is contained within srcImage
Dave Houltonee281a52017-12-08 13:51:02 -07002671 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2672 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002673 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002674 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002675 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2676 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2677 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002678 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002679 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002680 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002681
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002682 // The destination region specified by a given element of regions must be a region that is contained within dst_image
Dave Houltonee281a52017-12-08 13:51:02 -07002683 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2684 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002685 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002686 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002687 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2688 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2689 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002691 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002692 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002693 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002694
Dave Houltonfc1a4052017-04-27 14:32:45 -06002695 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002696 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2697 if (slice_override) src_copy_extent.depth = depth_slices;
2698 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002699 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002700 skip |=
2701 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2702 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2703 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2704 "width [%1d].",
2705 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002706 }
2707
2708 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002709 skip |=
2710 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2711 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2712 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2713 "height [%1d].",
2714 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002715 }
2716 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002717 skip |=
2718 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2719 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2720 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2721 "depth [%1d].",
2722 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002723 }
2724
Dave Houltonee281a52017-12-08 13:51:02 -07002725 // Adjust dest extent if necessary
2726 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2727 if (slice_override) dst_copy_extent.depth = depth_slices;
2728
2729 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002730 if (extent_check & x_bit) {
2731 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002732 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002733 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002734 "width [%1d].",
2735 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002736 }
2737 if (extent_check & y_bit) {
2738 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002739 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002740 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002741 "height [%1d].",
2742 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002743 }
2744 if (extent_check & z_bit) {
2745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002746 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002747 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002748 "depth [%1d].",
2749 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002750 }
2751
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002752 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2753 // must not overlap in memory
2754 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002755 for (uint32_t j = 0; j < regionCount; j++) {
2756 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002757 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002758 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002759 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002760 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002761 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002762 }
2763 }
2764 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002765 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002766
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002767 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2768 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2769 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002770 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002771 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2772 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002773 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002774 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002775 }
2776 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002777 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002778 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002780 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002781 }
2782 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002783
Dave Houlton33c22b72017-02-28 13:16:02 -07002784 // Source and dest image sample counts must match
2785 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2786 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2787 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002788 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002789 }
2790
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002791 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2792 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002793 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002794 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2795 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2796 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2797 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002798 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002799 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2800 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2801 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2802 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002803 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002804 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002805 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002806 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2807 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002808 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002809 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2810 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2811 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2812 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2813 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2814 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002815 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002816 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002817 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2818 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002819 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002820 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2821 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002822 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2823 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002824 }
2825
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002826 return skip;
2827}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002828
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002829void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2830 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2831 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002832 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2833 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002834 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002835 auto src_image_state = GetImageState(srcImage);
2836 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002837
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002838 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002839 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002840 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2841 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002842 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002843}
2844
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002845// Returns true if sub_rect is entirely contained within rect
2846static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2847 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2848 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2849 return false;
2850 return true;
2851}
2852
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002853bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002854 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2855 const VkRect2D &render_area, uint32_t rect_count,
2856 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002857 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002858 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2859 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002860 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002861 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002862
2863 for (uint32_t j = 0; j < rect_count; j++) {
2864 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002865 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
John Zulauf3a548ef2019-02-01 16:14:07 -07002866 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2867 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2868 "the current render pass instance.",
2869 j);
2870 }
2871
2872 if (image_view_state) {
2873 // The layers specified by a given element of pRects must be contained within every attachment that
2874 // pAttachments refers to
2875 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2876 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2877 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2879 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2880 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2881 "of pAttachment[%d].",
2882 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002883 }
2884 }
2885 }
2886 return skip;
2887}
2888
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002889bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2890 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002891 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002892 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002893 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002894 if (!cb_node) return skip;
2895
2896 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2897 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2898 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002899 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002900
2901 // Validate that attachment is in reference list of active subpass
2902 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002903 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002904 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002905 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002906 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002907 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002908
John Zulauf3a548ef2019-02-01 16:14:07 -07002909 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2910 auto clear_desc = &pAttachments[attachment_index];
2911 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002912
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002913 if (0 == clear_desc->aspectMask) {
2914 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002915 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002916 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2917 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002918 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002919 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002920 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2921 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2922 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2923 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002924 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2925 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2926 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2927 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2928 attachment_index, clear_desc->colorAttachment,
2929 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2930 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2931 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002932
John Zulauff2582972019-02-09 14:53:30 -07002933 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2934 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002935 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2937 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002938 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002939 " subpass %u. colorAttachmentCount=%u",
2940 attachment_index, clear_desc->colorAttachment,
2941 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2942 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002943 }
John Zulauff2582972019-02-09 14:53:30 -07002944 fb_attachment = color_attachment;
2945
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002946 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2947 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2948 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002949 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002950 skip |=
2951 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2952 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002953 }
2954 } else { // Must be depth and/or stencil
2955 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2956 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002957 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002958 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
John Zulauf3a548ef2019-02-01 16:14:07 -07002959 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2960 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002961 }
2962 if (!subpass_desc->pDepthStencilAttachment ||
2963 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2964 skip |= log_msg(
2965 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002966 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002967 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002968 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002969 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002970 }
2971 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002972 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002973 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2974 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002975 }
2976 }
2977 }
2978 return skip;
2979}
2980
2981void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2982 const VkClearAttachment *pAttachments, uint32_t rectCount,
2983 const VkClearRect *pRects) {
2984 auto *cb_node = GetCBState(commandBuffer);
2985 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2986 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2987 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2988 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2989 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2990 const auto clear_desc = &pAttachments[attachment_index];
2991 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2992 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2993 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2994 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2995 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2996 subpass_desc->pDepthStencilAttachment) {
2997 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2998 }
2999 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003000 if (!clear_rect_copy) {
3001 // We need a copy of the clear rectangles that will persist until the last lambda executes
3002 // but we want to create it as lazily as possible
3003 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003004 }
John Zulauf441558b2019-08-12 11:47:39 -06003005 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3006 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003007 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003008 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003009 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003010 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003011 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3012 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003013 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3014 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003015 return skip;
3016 };
3017 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003018 }
3019 }
3020 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003021}
3022
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003023bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3024 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003025 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003026 const auto *cb_node = GetCBState(commandBuffer);
3027 const auto *src_image_state = GetImageState(srcImage);
3028 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003029
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003030 bool skip = false;
3031 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003032 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3033 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003034 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003035 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003036 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3037 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003038 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3039 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003040
Cort Stratton7df30962018-05-17 19:45:57 -07003041 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003042 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003043 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003044 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3045 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3046 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003047 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003048 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3049 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003050 // For each region, the number of layers in the image subresource should not be zero
3051 // For each region, src and dest image aspect must be color only
3052 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003053 skip |=
3054 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3055 skip |=
3056 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003057 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003058 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3059 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003060 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003061 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3062 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003063 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3064 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3065 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3066 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3067 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003068 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3069 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003070 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003071 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3072 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003073
3074 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003075 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3076 skip |= log_msg(
3077 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003078 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003079 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003080 }
Cort Stratton7df30962018-05-17 19:45:57 -07003081 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003082 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3083 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3084 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003085 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003086 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003087 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003088 }
3089 }
3090
3091 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3092 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003093 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003094 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003095 }
3096 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3097 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003098 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003099 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003100 }
3101 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3102 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3103 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003104 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003105 }
3106 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3107 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3108 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003109 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003110 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003111 } else {
3112 assert(0);
3113 }
3114 return skip;
3115}
3116
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003117bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3118 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003119 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003120 const auto *cb_node = GetCBState(commandBuffer);
3121 const auto *src_image_state = GetImageState(srcImage);
3122 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003123
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003124 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003125 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003126 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003127 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003128 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003129 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003130 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003131 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003132 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003133 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3134 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003135 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003136 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3137 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003138 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003139 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3140 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003141 skip |=
3142 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003143 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3144 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003145 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003146 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003147 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003148 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003149
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003150 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003151
Dave Houlton33c2d252017-06-09 17:08:32 -06003152 VkFormat src_format = src_image_state->createInfo.format;
3153 VkFormat dst_format = dst_image_state->createInfo.format;
3154 VkImageType src_type = src_image_state->createInfo.imageType;
3155 VkImageType dst_type = dst_image_state->createInfo.imageType;
3156
Cort Stratton186b1a22018-05-01 20:18:06 -04003157 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003158 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003159 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3160 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003161 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003162 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3163 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3164 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003165 }
3166
3167 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003169 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003170 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003171 }
3172
Dave Houlton33c2d252017-06-09 17:08:32 -06003173 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3174 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3175 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003176 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003177 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003178 }
3179
3180 // Validate consistency for unsigned formats
3181 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3182 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003183 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003184 << "the other one must also have unsigned integer format. "
3185 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003187 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003188 }
3189
3190 // Validate consistency for signed formats
3191 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3192 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003193 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003194 << "the other one must also have signed integer format. "
3195 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3196 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003197 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003198 }
3199
3200 // Validate filter for Depth/Stencil formats
3201 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3202 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003203 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003204 << "then filter must be VK_FILTER_NEAREST.";
3205 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003206 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 }
3208
3209 // Validate aspect bits and formats for depth/stencil images
3210 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3211 if (src_format != dst_format) {
3212 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003214 << "stencil, the other one must have exactly the same format. "
3215 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3216 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003217 skip |=
3218 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3219 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003221 } // Depth or Stencil
3222
3223 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003224 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003225 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003226 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3227 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3228 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003229 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003230 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3231 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003232 for (uint32_t i = 0; i < regionCount; i++) {
3233 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003234 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003235 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003236 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3237 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003238 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003239 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3240 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003241 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3242 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3243 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003244 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003245 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003246 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003247 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003248 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3249 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003250 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003251 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3252 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003253 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003254 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3255 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003256 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003257 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003258 skip |=
3259 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3260 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003261 }
Dave Houlton48989f32017-05-26 15:01:46 -06003262 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3263 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003264 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003265 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003266 skip |=
3267 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3268 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003269 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003270
3271 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003272 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003273 skip |= log_msg(
3274 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3275 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3276 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003277 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003278
Dave Houlton48989f32017-05-26 15:01:46 -06003279 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003280 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003281 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003282 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003283 }
Dave Houlton48989f32017-05-26 15:01:46 -06003284
Dave Houlton33c2d252017-06-09 17:08:32 -06003285 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3286 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003287 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003288 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003289 "image format %s.",
3290 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003291 }
3292
3293 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3294 skip |= log_msg(
3295 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003296 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003297 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3298 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003299 }
3300
Dave Houlton48989f32017-05-26 15:01:46 -06003301 // Validate source image offsets
3302 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003303 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003304 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003305 skip |=
3306 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3307 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3308 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3309 "of (%1d, %1d). These must be (0, 1).",
3310 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003311 }
3312 }
3313
Dave Houlton33c2d252017-06-09 17:08:32 -06003314 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003315 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3316 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003317 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003318 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003319 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3320 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003321 }
3322 }
3323
Dave Houlton33c2d252017-06-09 17:08:32 -06003324 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003325 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3326 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003327 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003328 skip |= log_msg(
3329 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3330 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3331 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3332 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003333 }
3334 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3335 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003336 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003337 skip |= log_msg(
3338 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003339 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003340 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003341 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003342 }
3343 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3344 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003345 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003346 skip |= log_msg(
3347 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3348 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3349 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3350 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003351 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003352 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003353 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003354 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003355 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003356 }
Dave Houlton48989f32017-05-26 15:01:46 -06003357
3358 // Validate dest image offsets
3359 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003360 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003361 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003362 skip |=
3363 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3364 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3365 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3366 "(%1d, %1d). These must be (0, 1).",
3367 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003368 }
3369 }
3370
Dave Houlton33c2d252017-06-09 17:08:32 -06003371 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003372 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003374 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003375 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003376 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3377 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003378 }
3379 }
3380
Dave Houlton33c2d252017-06-09 17:08:32 -06003381 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003382 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3383 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003384 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003385 skip |= log_msg(
3386 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3387 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3388 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3389 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003390 }
3391 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3392 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003393 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003394 skip |= log_msg(
3395 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003396 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003397 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003398 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003399 }
3400 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3401 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003402 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003403 skip |= log_msg(
3404 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3405 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3406 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3407 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003408 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003409 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003410 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003411 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003412 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003413 }
3414
Dave Houlton33c2d252017-06-09 17:08:32 -06003415 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3416 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3417 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003418 skip |=
3419 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3420 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3421 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3422 "layerCount other than 1.",
3423 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003424 }
3425 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003426 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003427 } else {
3428 assert(0);
3429 }
3430 return skip;
3431}
3432
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003433void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3434 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3435 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003436 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3437 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003438 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003439 auto src_image_state = GetImageState(srcImage);
3440 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003441
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003442 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003443 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003444 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3445 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003446 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003447}
3448
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003449// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
John Zulauf3b04ebd2019-07-18 14:08:11 -06003450bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3451 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003452 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003453 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003454 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003455 // Iterate over the layout maps for each referenced image
3456 for (const auto &layout_map_entry : pCB->image_layout_map) {
3457 const auto image = layout_map_entry.first;
3458 const auto *image_state = GetImageState(image);
3459 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003460 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003461 ImageSubresourcePair isr_pair;
3462 isr_pair.image = image;
3463 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003464 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003465 for (const auto &pos : subres_map->InitialLayoutView()) {
3466 isr_pair.subresource = pos.subresource;
3467 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003468 VkImageLayout image_layout;
3469 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3470 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3471 // TODO: Set memory invalid which is in mem_tracker currently
3472 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003473 // Need to look up the inital layout *state* to get a bit more information
3474 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3475 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3476 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3477 if (!matches) {
3478 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003479 skip |= log_msg(
3480 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3481 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003482 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003483 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003484 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003485 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3486 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003487 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003488 }
3489 }
John Zulauff660ad62019-03-23 07:16:05 -06003490 }
3491
3492 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003493 for (const auto &pos : subres_map->CurrentLayoutView()) {
3494 VkImageLayout layout = pos.it->second;
3495 assert(layout != kInvalidLayout);
3496 isr_pair.subresource = pos.subresource;
3497 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003498 }
3499 }
John Zulauff660ad62019-03-23 07:16:05 -06003500
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003501 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003502}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003503
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003504void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003505 for (const auto &layout_map_entry : pCB->image_layout_map) {
3506 const auto image = layout_map_entry.first;
3507 const auto *image_state = GetImageState(image);
3508 if (!image_state) continue; // Can't set layouts of a dead image
3509 const auto &subres_map = layout_map_entry.second;
3510 ImageSubresourcePair isr_pair;
3511 isr_pair.image = image;
3512 isr_pair.hasSubresource = true;
3513
3514 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003515 for (const auto &pos : subres_map->CurrentLayoutView()) {
3516 VkImageLayout layout = pos.it->second;
3517 assert(layout != kInvalidLayout);
3518 isr_pair.subresource = pos.subresource;
3519 SetGlobalLayout(isr_pair, layout);
John Zulauff660ad62019-03-23 07:16:05 -06003520 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003521 }
3522}
3523
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003524// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003525// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3526// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003527bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3528 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003529 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003530 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003531 const char *vuid;
3532 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3533
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003534 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3535 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003536 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3537 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3538 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003539 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003540 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003541 "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
Shannon McPherson3ea65132018-12-05 10:37:39 -07003542 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3543 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3544 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3545 skip |=
3546 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3547 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003548 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003549 }
3550 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003551 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3552 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003553 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003554 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003555 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003556 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003557 }
3558 }
3559
3560 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3561 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003562 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003563 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003564 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
Dave Houltond8ed0212018-05-16 17:18:24 -06003565 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003566 }
3567 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003568 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003569}
3570
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003571bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3572 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003573 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003574 const char *vuid;
3575 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003576
Jason Ekstranda1906302017-12-03 20:16:32 -08003577 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3578 VkFormat format = pCreateInfo->pAttachments[i].format;
3579 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3580 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3581 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003582 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003583 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003584 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3585 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3586 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3587 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003588 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003589 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003590 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003591 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003592 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3593 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3594 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3595 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003596 }
3597 }
3598 }
3599
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003600 // Track when we're observing the first use of an attachment
3601 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3602 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003603 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003604
3605 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3606 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3607 auto attach_index = subpass.pInputAttachments[j].attachment;
3608 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003609 switch (subpass.pInputAttachments[j].layout) {
3610 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3611 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3612 // These are ideal.
3613 break;
3614
3615 case VK_IMAGE_LAYOUT_GENERAL:
3616 // May not be optimal. TODO: reconsider this warning based on other constraints.
3617 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003618 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003619 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3620 break;
3621
Tobias Hectorbbb12282018-10-22 15:17:59 +01003622 case VK_IMAGE_LAYOUT_UNDEFINED:
3623 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003624 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003625 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3626 "Layout for input attachment reference %u in subpass %u is %s but must be "
3627 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003628 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003629 break;
3630
Piers Daniell9af77cd2019-10-16 13:54:12 -06003631 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3632 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3633 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3634 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003635 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003636 skip |= log_msg(
3637 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003638 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003639 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3640 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3641 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3642 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3643 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3644 skip |= log_msg(
3645 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003646 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003647 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3648 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3649 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3650 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3651 } else if ((subpass.pInputAttachments[j].aspectMask &
3652 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3653 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3654 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3655 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3656 const auto *attachment_reference_stencil_layout =
3657 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3658 if (attachment_reference_stencil_layout) {
3659 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3660 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3661 attachment_reference_stencil_layout->stencilLayout ==
3662 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3663 attachment_reference_stencil_layout->stencilLayout ==
3664 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3665 attachment_reference_stencil_layout->stencilLayout ==
3666 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3667 attachment_reference_stencil_layout->stencilLayout ==
3668 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3669 attachment_reference_stencil_layout->stencilLayout ==
3670 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3671 attachment_reference_stencil_layout->stencilLayout ==
3672 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3673 attachment_reference_stencil_layout->stencilLayout ==
3674 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3675 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3676 skip |=
3677 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003678 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003679 "In the attachment reference %u in subpass %u with pNext chain instance "
3680 "VkAttachmentReferenceStencilLayoutKHR"
3681 "the stencilLayout member but must not be "
3682 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3683 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3684 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3685 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3686 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3687 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3688 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3689 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3690 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3691 j, i);
3692 }
3693 } else {
3694 skip |=
3695 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003696 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003697 "When the layout for input attachment reference %u in subpass %u is "
3698 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3699 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3700 "VkAttachmentReferenceStencilLayout instance.",
3701 j, i);
3702 }
3703 }
3704 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3705 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3706 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3707 skip |= log_msg(
3708 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003709 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003710 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3711 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3712 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3713 j, i);
3714 }
3715 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3716 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3717 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3718 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003719 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003720 "When the aspectMask for input attachment reference %u in subpass %u is "
3721 "VK_IMAGE_ASPECT_STENCIL_BIT "
3722 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3723 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3724 j, i);
3725 }
3726 }
3727 break;
3728
Graeme Leese668a9862018-10-08 10:40:02 +01003729 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3730 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003731 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003732 break;
3733 } else {
3734 // Intentionally fall through to generic error message
3735 }
3736 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003737
Cort Stratton7547f772017-05-04 15:18:52 -07003738 default:
3739 // No other layouts are acceptable
3740 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003741 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003742 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3743 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3744 }
3745
Cort Stratton7547f772017-05-04 15:18:52 -07003746 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003747 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3748 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003749
3750 bool used_as_depth =
3751 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3752 bool used_as_color = false;
3753 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3754 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3755 }
3756 if (!used_as_depth && !used_as_color &&
3757 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003758 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003759 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3760 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3761 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003762 }
3763 }
3764 attach_first_use[attach_index] = false;
3765 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003766
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003767 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3768 auto attach_index = subpass.pColorAttachments[j].attachment;
3769 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3770
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003771 // TODO: Need a way to validate shared presentable images here, currently just allowing
3772 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3773 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003774 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003775 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003776 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003777 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3778 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003779 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003780
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003781 case VK_IMAGE_LAYOUT_GENERAL:
3782 // May not be optimal; TODO: reconsider this warning based on other constraints?
3783 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003784 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003785 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3786 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003787
Tobias Hectorbbb12282018-10-22 15:17:59 +01003788 case VK_IMAGE_LAYOUT_UNDEFINED:
3789 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003790 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003791 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3792 "Layout for color attachment reference %u in subpass %u is %s but should be "
3793 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3794 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3795 break;
3796
Piers Daniell9af77cd2019-10-16 13:54:12 -06003797 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3798 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3799 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3800 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003801 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003802 skip |= log_msg(
3803 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003804 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003805 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3806 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3807 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3808 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3809 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3810 skip |= log_msg(
3811 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003812 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003813 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3814 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3815 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3816 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3817 } else if ((subpass.pColorAttachments[j].aspectMask &
3818 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3819 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3820 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3821 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3822 const auto *attachment_reference_stencil_layout =
3823 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3824 if (attachment_reference_stencil_layout) {
3825 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3826 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3827 attachment_reference_stencil_layout->stencilLayout ==
3828 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3829 attachment_reference_stencil_layout->stencilLayout ==
3830 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3831 attachment_reference_stencil_layout->stencilLayout ==
3832 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3833 attachment_reference_stencil_layout->stencilLayout ==
3834 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3835 attachment_reference_stencil_layout->stencilLayout ==
3836 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3837 attachment_reference_stencil_layout->stencilLayout ==
3838 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3839 attachment_reference_stencil_layout->stencilLayout ==
3840 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3841 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3842 skip |=
3843 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003844 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003845 "In the attachment reference %u in subpass %u with pNext chain instance "
3846 "VkAttachmentReferenceStencilLayoutKHR"
3847 "the stencilLayout member but must not be "
3848 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3849 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3850 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3851 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3852 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3853 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3854 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3855 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3856 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3857 j, i);
3858 }
3859 } else {
3860 skip |=
3861 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003862 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003863 "When the layout for color attachment reference %u in subpass %u is "
3864 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3865 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3866 "VkAttachmentReferenceStencilLayout instance.",
3867 j, i);
3868 }
3869 }
3870 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3871 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3872 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3873 skip |= log_msg(
3874 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003875 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003876 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3877 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3878 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3879 j, i);
3880 }
3881 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3882 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3883 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3884 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003885 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003886 "When the aspectMask for color attachment reference %u in subpass %u is "
3887 "VK_IMAGE_ASPECT_STENCIL_BIT "
3888 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3889 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3890 j, i);
3891 }
3892 }
3893 break;
3894
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003895 default:
3896 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06003897 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003898 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3899 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003900 }
3901
John Zulauf4eee2692019-02-09 16:14:25 -07003902 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3903 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3904 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003905 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
John Zulauf4eee2692019-02-09 16:14:25 -07003907 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003908 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003909 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003910 }
3911
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003912 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003913 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3914 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003915 }
3916 attach_first_use[attach_index] = false;
3917 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003918
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003919 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3920 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003921 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3922 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3923 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003924 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003925
Dave Houltona9df0ce2018-02-07 10:51:23 -07003926 case VK_IMAGE_LAYOUT_GENERAL:
3927 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3928 // doing a bunch of transitions.
3929 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003930 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003931 "GENERAL layout for depth attachment may not give optimal performance.");
3932 break;
3933
Tobias Hectorbbb12282018-10-22 15:17:59 +01003934 case VK_IMAGE_LAYOUT_UNDEFINED:
3935 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003936 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003937 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3938 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3939 "layout or GENERAL.",
3940 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3941 break;
3942
Piers Daniell9af77cd2019-10-16 13:54:12 -06003943 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3944 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3945 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3946 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003947 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003948 skip |= log_msg(
3949 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003950 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003951 "Layout for depth attachment reference in subpass %u is %s but must not be "
3952 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3953 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3954 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3955 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3956 skip |= log_msg(
3957 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003958 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003959 "Layout for depth attachment reference in subpass %u is %s but must not be "
3960 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3961 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3962 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3963 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3964 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3965 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3966 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3967 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3968 const auto *attachment_reference_stencil_layout =
3969 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3970 if (attachment_reference_stencil_layout) {
3971 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3972 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3973 attachment_reference_stencil_layout->stencilLayout ==
3974 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3975 attachment_reference_stencil_layout->stencilLayout ==
3976 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3977 attachment_reference_stencil_layout->stencilLayout ==
3978 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3979 attachment_reference_stencil_layout->stencilLayout ==
3980 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3981 attachment_reference_stencil_layout->stencilLayout ==
3982 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3983 attachment_reference_stencil_layout->stencilLayout ==
3984 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3985 attachment_reference_stencil_layout->stencilLayout ==
3986 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3987 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3988 skip |=
3989 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003990 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003991 "In the attachment reference in subpass %u with pNext chain instance "
3992 "VkAttachmentReferenceStencilLayoutKHR"
3993 "the stencilLayout member but must not be "
3994 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3995 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3996 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3997 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3998 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3999 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4000 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4001 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4002 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4003 i);
4004 }
4005 } else {
4006 skip |=
4007 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004008 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004009 "When the layout for depth attachment reference in subpass %u is "
4010 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4011 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4012 "VkAttachmentReferenceStencilLayout instance.",
4013 i);
4014 }
4015 }
4016 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4017 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4018 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
4019 skip |= log_msg(
4020 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004021 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004022 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4023 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4024 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4025 i);
4026 }
4027 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4028 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4029 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4030 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004031 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004032 "When the aspectMask for depth attachment reference in subpass %u is "
4033 "VK_IMAGE_ASPECT_STENCIL_BIT "
4034 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4035 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4036 i);
4037 }
4038 }
4039 break;
4040
Dave Houltona9df0ce2018-02-07 10:51:23 -07004041 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4042 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004043 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004044 break;
4045 } else {
4046 // Intentionally fall through to generic error message
4047 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004048 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004049
Dave Houltona9df0ce2018-02-07 10:51:23 -07004050 default:
4051 // No other layouts are acceptable
4052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houlton51653902018-06-22 17:32:13 -06004053 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004054 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4055 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4056 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004057 }
4058
4059 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4060 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004061 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4062 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004063 }
4064 attach_first_use[attach_index] = false;
4065 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004066 }
4067 return skip;
4068}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004069
Mark Lobodzinski96210742017-02-09 10:33:46 -07004070// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4071// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06004072bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004073 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004074 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004075 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004076 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004077 if (strict) {
4078 correct_usage = ((actual & desired) == desired);
4079 } else {
4080 correct_usage = ((actual & desired) != 0);
4081 }
4082 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004083 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004084 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06004085 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
4086 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06004087 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4088 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004089 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06004090 skip =
4091 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type], typed_handle.handle,
locke-lunarg9edc2812019-06-17 23:18:52 -06004092 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4093 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004094 }
4095 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004096 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004097}
4098
4099// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4100// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004101bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004102 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004103 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
4104 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004105}
4106
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004107bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004108 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004109 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004110 bool skip = false;
4111 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4112 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07004113 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4114 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004115 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07004116 format_properties.linearTilingFeatures, image_state->createInfo.format,
4117 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004118 }
4119 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4120 if ((format_properties.optimalTilingFeatures & desired) != desired) {
4121 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4122 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004123 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04004124 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07004125 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004126 }
4127 }
4128 return skip;
4129}
4130
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004131bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004132 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004133 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004134 // layerCount must not be zero
4135 if (subresource_layers->layerCount == 0) {
4136 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
4138 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
4139 }
4140 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4141 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
4142 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4143 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
4144 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
4145 }
4146 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4147 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4148 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4149 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4150 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
4151 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4152 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4153 func_name, i, member);
4154 }
4155 return skip;
4156}
4157
Mark Lobodzinski96210742017-02-09 10:33:46 -07004158// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4159// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004160bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004161 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004162 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
4163 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004164}
4165
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004166bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004167 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004168 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004169
4170 const VkDeviceSize &range = pCreateInfo->range;
4171 if (range != VK_WHOLE_SIZE) {
4172 // Range must be greater than 0
4173 if (range <= 0) {
4174 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4175 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
4176 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4177 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4178 range);
4179 }
4180 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004181 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4182 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004183 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4184 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
4185 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4186 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
Petr Kraus5a01b472019-08-10 01:40:28 +02004187 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004188 range, format_size);
4189 }
4190 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004191 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
4192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4193 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
4194 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4195 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4196 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4197 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004198 }
4199 // The sum of range and offset must be less than or equal to the size of buffer
4200 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
4201 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4202 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
4203 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4204 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4205 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4206 range, pCreateInfo->offset, buffer_state->createInfo.size);
4207 }
4208 }
4209 return skip;
4210}
4211
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004212bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004213 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004214 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004215 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4216 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
4217 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4218 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
4219 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4220 "be supported for uniform texel buffers");
4221 }
4222 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4223 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
4224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4225 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
4226 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4227 "be supported for storage texel buffers");
4228 }
4229 return skip;
4230}
4231
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004232bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004233 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004234 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004235
Dave Houltond8ed0212018-05-16 17:18:24 -06004236 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004237
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004238 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004239 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06004240 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004241 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004242 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004243 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004244
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004245 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004246 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06004247 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004248 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004249 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004250 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004251
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004252 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004253 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06004254 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004255 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004256 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004257 }
Jeff Bolz87697532019-01-11 22:54:00 -06004258
4259 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4260 if (chained_devaddr_struct) {
4261 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4262 chained_devaddr_struct->deviceAddress != 0) {
4263 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4264 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4265 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4266 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4267 }
4268 }
4269
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004270 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4271 if (chained_opaqueaddr_struct) {
4272 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4273 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
4274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4275 "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4276 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4277 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
4278 }
4279 }
4280
Shannon McPherson4984e642019-12-05 13:04:34 -07004281 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004282 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004283 skip |= log_msg(
4284 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPherson4984e642019-12-05 13:04:34 -07004285 "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004286 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4287 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4288 }
4289
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004290 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004291 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4292 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4293 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004294 }
4295
Mark Lobodzinski96210742017-02-09 10:33:46 -07004296 return skip;
4297}
4298
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004299bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004300 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004301 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004302 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004303 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4304 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004305 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004306 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4307 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004308 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004309 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4310 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4311 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004312
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004313 // Buffer view offset must be less than the size of buffer
4314 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4315 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4316 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4317 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4318 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4319 pCreateInfo->offset, buffer_state->createInfo.size);
4320 }
4321
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004322 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004323 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4324 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4325 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4326 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4327 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4328 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4329 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4330 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4331 }
4332
4333 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4334 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4335 if ((elementSize % 3) == 0) {
4336 elementSize /= 3;
4337 }
4338 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4339 VkDeviceSize alignmentRequirement =
4340 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4341 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4342 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4343 }
4344 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4345 skip |= log_msg(
4346 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4347 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4348 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4349 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4350 ") must be a multiple of the lesser of "
4351 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4352 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4353 "(%" PRId32
4354 ") is VK_TRUE, the size of a texel of the requested format. "
4355 "If the size of a texel is a multiple of three bytes, then the size of a "
4356 "single component of format is used instead",
4357 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4358 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4359 }
4360 }
4361 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4362 VkDeviceSize alignmentRequirement =
4363 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4364 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4365 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4366 }
4367 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4368 skip |= log_msg(
4369 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4370 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4371 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4372 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4373 ") must be a multiple of the lesser of "
4374 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4375 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4376 "(%" PRId32
4377 ") is VK_TRUE, the size of a texel of the requested format. "
4378 "If the size of a texel is a multiple of three bytes, then the size of a "
4379 "single component of format is used instead",
4380 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4381 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4382 }
4383 }
4384 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004385
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004386 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004387
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004388 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004389 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004390 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004391}
4392
Mark Lobodzinski602de982017-02-09 11:01:33 -07004393// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004394bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004395 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004396 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004397 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4398 if (image != VK_NULL_HANDLE) {
4399 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4400 }
4401
Dave Houlton1d2022c2017-03-29 11:43:58 -06004402 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004403 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004404 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004405 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004406 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004408 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004409 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004410 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004411 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004412 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004413 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004414 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4415 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004416 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004417 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004418 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004419 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4420 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004421 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004422 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004423 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004425 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004426 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004428 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004429 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004430 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004431 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004432 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004433 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004434 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004435 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004436 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004437 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004438 } else if (FormatIsMultiplane(format)) {
4439 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4440 if (3 == FormatPlaneCount(format)) {
4441 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4442 }
4443 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004444 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004445 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4446 "set, where n = [0, 1, 2].",
4447 func_name);
4448 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004449 }
4450 return skip;
4451}
4452
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004453bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4454 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4455 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004456 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004457 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004458
4459 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004460 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004461 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004462 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004463 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004464 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4465 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004466 }
Petr Kraus4d718682017-05-18 03:38:41 +02004467
Petr Krausffa94af2017-08-08 21:46:02 +02004468 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4469 if (subresourceRange.levelCount == 0) {
4470 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004471 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004472 } else {
4473 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004474
Petr Krausffa94af2017-08-08 21:46:02 +02004475 if (necessary_mip_count > image_mip_count) {
4476 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004477 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004478 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004479 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004480 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004481 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004482 }
Petr Kraus4d718682017-05-18 03:38:41 +02004483 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004484 }
Petr Kraus4d718682017-05-18 03:38:41 +02004485
4486 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004487 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004488 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004489 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004490 "%s: %s.baseArrayLayer (= %" PRIu32
4491 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4492 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004493 }
Petr Kraus4d718682017-05-18 03:38:41 +02004494
Petr Krausffa94af2017-08-08 21:46:02 +02004495 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4496 if (subresourceRange.layerCount == 0) {
4497 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004498 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004499 } else {
4500 const uint64_t necessary_layer_count =
4501 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004502
Petr Krausffa94af2017-08-08 21:46:02 +02004503 if (necessary_layer_count > image_layer_count) {
4504 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004505 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004506 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004507 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004508 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004509 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004510 }
Petr Kraus4d718682017-05-18 03:38:41 +02004511 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004512 }
Petr Kraus4d718682017-05-18 03:38:41 +02004513
Mark Lobodzinski602de982017-02-09 11:01:33 -07004514 return skip;
4515}
4516
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004517bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004518 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004519 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004520 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4521 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4522 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4523
4524 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4525 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4526
4527 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004528 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4529 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004530 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004531 : "VUID-VkImageViewCreateInfo-image-01482")
4532 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4533 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004534 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004535 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4536 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004537
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004538 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004539 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4540 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4541}
4542
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004543bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004544 const VkImageSubresourceRange &subresourceRange,
4545 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004546 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004547 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4548 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4549 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4550 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004551
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004552 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4553 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4554 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004555}
4556
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004557bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004558 const VkImageSubresourceRange &subresourceRange,
4559 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004560 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004561 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4562 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4563 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4564 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004565
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004566 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4567 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004568 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4569}
4570
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004571bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004572 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004573 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004574 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004575 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4576 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4577 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4578 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004579
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004580 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4581 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004582 subresourceRangeErrorCodes);
4583}
4584
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004585bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004586 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004587 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004588 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004589 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004590 skip |=
4591 ValidateImageUsageFlags(image_state,
4592 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4593 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4594 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4595 false, kVUIDUndefined, "vkCreateImageView()",
4596 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4597 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004598 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004599 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004600 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004601 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004602 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004603 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004604
4605 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4606 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004607 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4608 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004609 VkFormat view_format = pCreateInfo->format;
4610 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004611 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004612 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004613
Dave Houltonbd2e2622018-04-10 16:41:14 -06004614 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004615 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004616 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004617 image_usage = chained_ivuci_struct->usage;
4618 }
4619
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004620 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4621 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004622 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004623 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004624 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004625 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004626 std::stringstream ss;
4627 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004628 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004629 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004630 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004631 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004632 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004633 }
4634 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004635 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004636 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4637 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4638 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4639 std::stringstream ss;
4640 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004641 << " is not in the same format compatibility class as "
4642 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004643 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4644 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004645 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004646 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004647 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004648 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004649 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004650 }
4651 } else {
4652 // Format MUST be IDENTICAL to the format the image was created with
4653 if (image_format != view_format) {
4654 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004655 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004656 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004657 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004658 skip |=
4659 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004660 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004661 }
4662 }
4663
4664 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004665 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004666
4667 switch (image_type) {
4668 case VK_IMAGE_TYPE_1D:
4669 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004670 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004671 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004672 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4673 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004674 }
4675 break;
4676 case VK_IMAGE_TYPE_2D:
4677 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4678 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4679 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004681 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004682 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4683 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004684 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004685 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004686 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004687 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4688 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004689 }
4690 }
4691 break;
4692 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004693 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004694 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4695 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4696 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004697 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004698 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004699 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004700 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4701 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004702 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4703 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004704 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004705 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004706 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004707 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4708 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004709 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4710 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004711 }
4712 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004713 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004714 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004715 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4716 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004717 }
4718 }
4719 } else {
4720 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004722 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004723 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4724 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004725 }
4726 }
4727 break;
4728 default:
4729 break;
4730 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004731
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004732 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004733 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004734 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004735 }
4736
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004737 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004738 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4739 : format_properties.optimalTilingFeatures;
4740
4741 if (tiling_features == 0) {
4742 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004743 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004744 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4745 "physical device.",
4746 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4747 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4748 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004749 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004750 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4751 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4752 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4753 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4754 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004755 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004756 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4757 "VK_IMAGE_USAGE_STORAGE_BIT.",
4758 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4759 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4760 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4761 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004762 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004763 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4764 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4765 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4766 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4767 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4768 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004769 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004770 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4771 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4772 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004773 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004774
Jeff Bolz9af91c52018-09-01 21:53:57 -05004775 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4776 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4777 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004778 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004779 "vkCreateImageView() If image was created with usage containing "
4780 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4781 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4782 }
4783 if (view_format != VK_FORMAT_R8_UINT) {
4784 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004785 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004786 "vkCreateImageView() If image was created with usage containing "
4787 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4788 }
4789 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004790 }
4791 return skip;
4792}
4793
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004794static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4795 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4796 const VkBufferCopy *pRegions) {
4797 bool skip = false;
4798
4799 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4800 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4801 VkDeviceSize src_min = UINT64_MAX;
4802 VkDeviceSize src_max = 0;
4803 VkDeviceSize dst_min = UINT64_MAX;
4804 VkDeviceSize dst_max = 0;
4805
4806 for (uint32_t i = 0; i < regionCount; i++) {
4807 src_min = std::min(src_min, pRegions[i].srcOffset);
4808 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4809 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4810 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4811
4812 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4813 if (pRegions[i].srcOffset >= src_buffer_size) {
4814 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4815 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4816 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4817 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4818 i, pRegions[i].srcOffset, i, pRegions[i].size);
4819 }
4820
4821 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4822 if (pRegions[i].dstOffset >= dst_buffer_size) {
4823 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4824 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4825 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4826 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4827 i, pRegions[i].dstOffset, i, pRegions[i].size);
4828 }
4829
4830 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4831 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4832 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4833 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4834 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4835 ") is greater than the source buffer size (%" PRIuLEAST64
4836 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4837 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4838 }
4839
4840 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4841 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4842 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4843 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4844 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4845 ") is greater than the destination buffer size (%" PRIuLEAST64
4846 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4847 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4848 }
4849 }
4850
4851 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4852 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4853 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4854 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4855 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4856 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4857 }
4858 }
4859
4860 return skip;
4861}
4862
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004863bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004864 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004865 const auto cb_node = GetCBState(commandBuffer);
4866 const auto src_buffer_state = GetBufferState(srcBuffer);
4867 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004868
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004869 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004870 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4871 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004872 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004873 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004874 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4875 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004876 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004877 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4878 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004879 skip |=
4880 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4881 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004882 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4883 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004884 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004885 return skip;
4886}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004887
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004888bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004889 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004890 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004891 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004892 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
locke-lunarg9edc2812019-06-17 23:18:52 -06004893 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004894 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004895 } else {
4896 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004898 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004899 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004900 }
4901 }
4902 return skip;
4903}
4904
Jeff Bolz5c801d12019-10-09 10:38:45 -05004905bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4906 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004907 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004908 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004909
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004910 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004911 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004912 skip |=
4913 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004914 }
4915 return skip;
4916}
4917
Jeff Bolz5c801d12019-10-09 10:38:45 -05004918bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004919 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004920
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004921 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004922 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004923 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004924 }
4925 return skip;
4926}
4927
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004928bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004929 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004930 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004931 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004932 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004933 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004934 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004936 }
4937 return skip;
4938}
4939
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004940bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004941 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004942 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004943 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004944 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004945 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004946 skip |=
4947 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4948 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004949 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004950 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004951 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4952 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004953 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004954
4955 if (dstOffset >= buffer_state->createInfo.size) {
4956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4957 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-dstOffset-00024",
4958 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4959 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4960 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
4961 }
4962
4963 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
4964 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4965 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-size-00027",
4966 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4967 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4968 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
4969 }
4970
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004971 return skip;
4972}
4973
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004974bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4975 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004976 bool skip = false;
4977
4978 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004979 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4980 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004981 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004982 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004983 "%s(): pRegion[%d] imageOffset.y is %d and imageExtent.height is %d. For 1D images these must be 0 "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004984 "and 1, respectively.",
4985 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004986 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004987 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004988
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004989 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4990 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004991 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004992 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004993 "%s(): pRegion[%d] imageOffset.z is %d and imageExtent.depth is %d. For 1D and 2D images these "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004994 "must be 0 and 1, respectively.",
4995 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004996 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004997 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004998
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004999 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5000 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005001 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005002 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005003 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5004 "For 3D images these must be 0 and 1, respectively.",
5005 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005006 }
5007 }
5008
5009 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005010 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005011 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5012
Dave Houltona585d132019-01-18 13:05:42 -07005013 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005014 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005015 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005016 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005017 " must be a multiple of this format's texel size (%" PRIu32 ").",
5018 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005019 }
5020
5021 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005022 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005023 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005024 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005025 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5026 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005027 }
5028
5029 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5030 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005031 skip |=
5032 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005033 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005034 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5035 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005036 }
5037
5038 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5039 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
5040 skip |= log_msg(
5041 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005042 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005043 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5044 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005045 }
5046
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005047 // Calculate adjusted image extent, accounting for multiplane image factors
5048 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
5049 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
5050 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
5051 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
5052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5053 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
5054 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5055 "zero or <= image subresource width (%d).",
5056 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
5057 adusted_image_extent.width);
5058 }
5059
5060 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
5061 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
5062 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
5063 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5064 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
5065 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5066 "zero or <= image subresource height (%d).",
5067 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
5068 adusted_image_extent.height);
5069 }
5070
5071 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
5072 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
5073 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
5074 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5075 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
5076 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5077 "zero or <= image subresource depth (%d).",
5078 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
5079 adusted_image_extent.depth);
5080 }
5081
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005082 // subresource aspectMask must have exactly 1 bit set
5083 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5084 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5085 if (aspect_mask_bits.count() != 1) {
5086 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005087 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005088 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005089 }
5090
5091 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005092 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005093 skip |= log_msg(
5094 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005095 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005096 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5097 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005098 }
5099
5100 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005101 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005102 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005103
5104 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005105 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005106 skip |= log_msg(
5107 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005108 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005109 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5110 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005111 }
5112
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005113 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005114 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07005115 skip |= log_msg(
5116 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005117 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005118 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5119 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005120 }
5121
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005122 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005123 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5124 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5125 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005126 skip |=
5127 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005128 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005129 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5130 "width & height (%d, %d)..",
5131 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005132 }
5133
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005134 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005135 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005136 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005137 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005138 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005139 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005140 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005141 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005142 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005143
5144 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005145 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005146 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005147 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
5148 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005149 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07005150 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005151 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005152 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005153 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005154 }
5155
5156 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005157 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005158 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
5159 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005160 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07005161 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005162 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005163 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005164 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005165 }
5166
5167 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005168 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005169 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
5170 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005171 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005172 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005173 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005174 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005175 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005176 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005177 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005178
5179 // Checks that apply only to multi-planar format images
5180 if (FormatIsMultiplane(image_state->createInfo.format)) {
5181 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5182 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5183 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5184 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5185 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5186 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5187 "format has three planes.",
5188 function, i);
5189 }
5190
5191 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5192 if (0 == (pRegions[i].imageSubresource.aspectMask &
5193 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
5194 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5195 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5196 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5197 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5198 function, i);
5199 }
5200 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005201 }
5202
5203 return skip;
5204}
5205
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005206static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005207 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005208 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005209 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005210
5211 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005212 VkExtent3D extent = pRegions[i].imageExtent;
5213 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005214
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005215 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5216 {
Dave Houlton51653902018-06-22 17:32:13 -06005217 skip |=
5218 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5219 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5220 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005221 }
5222
5223 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5224
5225 // 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 -06005226 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005227 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005228 if (image_extent.width % block_extent.width) {
5229 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5230 }
5231 if (image_extent.height % block_extent.height) {
5232 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5233 }
5234 if (image_extent.depth % block_extent.depth) {
5235 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5236 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005237 }
5238
Dave Houltonfc1a4052017-04-27 14:32:45 -06005239 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005240 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
Mark Lobodzinski88529492018-04-01 10:38:15 -06005241 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005242 }
5243 }
5244
5245 return skip;
5246}
5247
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005248static inline bool ValidateBufferBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state,
5249 const BUFFER_STATE *buff_state, uint32_t regionCount, const VkBufferImageCopy *pRegions,
5250 const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005251 bool skip = false;
5252
5253 VkDeviceSize buffer_size = buff_state->createInfo.size;
5254
5255 for (uint32_t i = 0; i < regionCount; i++) {
5256 VkExtent3D copy_extent = pRegions[i].imageExtent;
5257
5258 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5259 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005260 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5261 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005262
Tom Cooperb2550c72018-10-15 13:08:41 +01005263 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005264 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005265 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005266 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5267 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5268
5269 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5270 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5271 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005272 }
5273
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005274 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5275 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5276 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005277 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005278 } else {
5279 // Calculate buffer offset of final copied byte, + 1.
5280 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5281 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5282 max_buffer_offset *= unit_size; // convert to bytes
5283 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005284
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005285 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005286 skip |=
5287 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5288 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005289 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005290 }
5291 }
5292
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005293 return skip;
5294}
5295
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005296bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005297 VkBuffer dstBuffer, uint32_t regionCount,
5298 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005299 const auto cb_node = GetCBState(commandBuffer);
5300 const auto src_image_state = GetImageState(srcImage);
5301 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005302
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005303 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005304
5305 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005306 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005307
5308 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005309 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005310
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005311 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005312
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005313 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5314 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005315 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005316 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005317 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005318 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005319 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005320 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005321 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005322 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005323
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005324 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005325 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005326 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5327 skip |=
5328 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005329
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005330 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005331 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005332 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5333 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005334 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005335 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5336 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005337 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005338 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5339 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005340 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005341 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005342 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005343 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005344 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5345 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5346 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005347 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005348 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005349 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005350 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005351 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5352 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005353 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5354 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5355 skip |=
5356 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5357 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5358 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005359 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5360 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005361 }
5362 return skip;
5363}
5364
John Zulauf1686f232019-07-09 16:27:11 -06005365void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5366 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5367 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5368
5369 auto cb_node = GetCBState(commandBuffer);
5370 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005371 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005372 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005373 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005374 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005375}
5376
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005377bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5378 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005379 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005380 const auto cb_node = GetCBState(commandBuffer);
5381 const auto src_buffer_state = GetBufferState(srcBuffer);
5382 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005383
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005384 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005385
5386 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005387 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005388
5389 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005390 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005391 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005392 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5393 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005394 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005395 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005396 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005397 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005398 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005399 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005400 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005401 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005402 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005403 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005404 skip |=
5405 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5406 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005407 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005408 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5409 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005410 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005411 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5412 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005413 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005414 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5415 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005416 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005417 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005418 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005419 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005420 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5421 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5422 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005423 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005424 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005425 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005426 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005427 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5428 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005429 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5430 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5431 skip |=
5432 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5433 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5434 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005435 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5436 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005437 }
5438 return skip;
5439}
5440
John Zulauf1686f232019-07-09 16:27:11 -06005441void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5442 VkImageLayout dstImageLayout, uint32_t regionCount,
5443 const VkBufferImageCopy *pRegions) {
5444 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5445
5446 auto cb_node = GetCBState(commandBuffer);
5447 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005448 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005449 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005450 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005451 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005452}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005453
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005454bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005455 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005456 bool skip = false;
5457 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5458
Dave Houlton1d960ff2018-01-19 12:17:05 -07005459 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005460 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5461 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5462 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005463 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005464 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005465 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005466 }
5467
John Zulaufa26d3c82019-08-14 16:09:08 -06005468 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005469 if (!image_entry) {
5470 return skip;
5471 }
5472
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005473 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5474 if (device_extensions.vk_ext_image_drm_format_modifier) {
5475 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5476 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5477 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5478 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5479 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5480 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5481 }
5482 } else {
5483 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5484 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5485 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5486 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5487 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005488 }
5489
Dave Houlton1d960ff2018-01-19 12:17:05 -07005490 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005491 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005492 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5493 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5494 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5495 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005496 }
5497
Dave Houlton1d960ff2018-01-19 12:17:05 -07005498 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005499 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5501 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5502 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5503 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005504 }
5505
Dave Houlton1d960ff2018-01-19 12:17:05 -07005506 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005507 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005508 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5509 if (FormatIsMultiplane(img_format)) {
5510 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5511 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5512 if (FormatPlaneCount(img_format) > 2u) {
5513 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5514 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5515 }
5516 if (sub_aspect != (sub_aspect & allowed_flags)) {
5517 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5518 HandleToUint64(image), vuid,
5519 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5520 ") must be a single-plane specifier flag.",
5521 sub_aspect);
5522 }
5523 } else if (FormatIsColor(img_format)) {
5524 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5525 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5526 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5527 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5528 "VK_IMAGE_ASPECT_COLOR.");
5529 }
5530 } else if (FormatIsDepthOrStencil(img_format)) {
5531 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5532 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005533 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005534 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5535 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5536 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5537 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005538 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005539 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5540 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5541 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005542 }
5543 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005544
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005545 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005546 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005547 }
5548
Mike Weiblen672b58b2017-02-21 14:32:53 -07005549 return skip;
5550}