blob: 51dcd1fe95fdedf12f18d7163c458516e139f623 [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;
Piers Daniell7f894f62020-01-09 16:33:48 -0700584 auto subresource_cb = [this, i, attachment_initial_layout, attachment_stencil_initial_layout, &layout_check,
585 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout,
586 VkImageLayout initial_layout) {
587 VkImageLayout checkLayout = attachment_initial_layout;
588 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) checkLayout = attachment_stencil_initial_layout;
589
590 if (!layout_check.Check(subres, checkLayout, layout, initial_layout)) {
591 subres_skip |= log_msg(
592 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
593 kVUID_Core_DrawState_InvalidRenderpass,
594 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
595 "and the %s layout of the attachment is %s. The layouts must match, or the render "
596 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
597 i, string_VkImageLayout(checkLayout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100598 }
599 return !subres_skip; // quit checking subresources once we fail once
600 };
601
Piers Daniell7f894f62020-01-09 16:33:48 -0700602 VkImageSubresourceRange range = view_state->normalized_subresource_range;
603 if (range.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
604 // Check the depth aspect, if it exists.
605 if (range.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
606 range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
607 subresource_map->ForRange(range, subresource_cb);
608 }
609
610 range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
611 subresource_map->ForRange(range, subresource_cb);
612 } else {
613 subresource_map->ForRange(range, subresource_cb);
614 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100615 skip |= subres_skip;
616 }
617
618 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
619 framebuffer, render_pass, i, "initial layout");
620
621 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
622 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100623 }
624
Tobias Hectorc9057422019-07-23 12:15:52 +0100625 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
626 auto &subpass = pRenderPassInfo->pSubpasses[j];
627 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
628 auto &attachment_ref = subpass.pInputAttachments[k];
629 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
630 auto image_view = attachments[attachment_ref.attachment];
631 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100632
Tobias Hectorc9057422019-07-23 12:15:52 +0100633 if (view_state) {
634 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700635 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
636 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100637 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100638 }
639 }
640 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100641
Tobias Hectorc9057422019-07-23 12:15:52 +0100642 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
643 auto &attachment_ref = subpass.pColorAttachments[k];
644 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
645 auto image_view = attachments[attachment_ref.attachment];
646 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100647
Tobias Hectorc9057422019-07-23 12:15:52 +0100648 if (view_state) {
649 auto image = view_state->create_info.image;
650 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
651 framebuffer, render_pass, attachment_ref.attachment,
652 "color attachment layout");
653 if (subpass.pResolveAttachments) {
654 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
655 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
656 attachment_ref.attachment, "resolve attachment layout");
657 }
658 }
659 }
660 }
661
662 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
663 auto &attachment_ref = *subpass.pDepthStencilAttachment;
664 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
665 auto image_view = attachments[attachment_ref.attachment];
666 auto view_state = GetImageViewState(image_view);
667
668 if (view_state) {
669 auto image = view_state->create_info.image;
670 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
671 framebuffer, render_pass, attachment_ref.attachment,
672 "input attachment layout");
673 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100674 }
675 }
676 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700677 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600678 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700679}
680
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600681void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700682 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700684 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600685 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700686 VkImageLayout stencil_layout = kInvalidLayout;
687 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
688 if (attachment_reference_stencil_layout) {
689 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
690 }
691
692 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600693 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 }
695}
696
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600697void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
698 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700699 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700700
701 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700702 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700703 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700704 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700705 }
706 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700707 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700708 }
709 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700710 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700711 }
712 }
713}
714
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700715// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
716// 1. Transition into initialLayout state
717// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600718void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700719 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700720 // First transition into initialLayout
721 auto const rpci = render_pass_state->createInfo.ptr();
722 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700723 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600724 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700725 VkImageLayout stencil_layout = kInvalidLayout;
726 const auto *attachment_description_stencil_layout =
727 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
728 if (attachment_description_stencil_layout) {
729 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
730 }
731
732 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600733 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700734 }
735 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700736 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700737}
738
Dave Houlton10b39482017-03-16 13:18:15 -0600739bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600740 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600741 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600742 }
743 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600744 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600745 }
746 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600747 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600748 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700749 if (0 !=
750 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
751 if (FormatPlaneCount(format) == 1) return false;
752 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600753 return true;
754}
755
Mike Weiblen62d08a32017-03-07 22:18:27 -0700756// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200757bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
758 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600759 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700760 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200761 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600762 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700763
764 switch (layout) {
765 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
766 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600767 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700768 }
769 break;
770 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
771 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600772 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700773 }
774 break;
775 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
776 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600777 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 }
779 break;
780 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
781 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600782 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700783 }
784 break;
785 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
786 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600787 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700788 }
789 break;
790 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
791 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600792 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700793 }
794 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600795 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500796 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
797 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
798 }
799 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700800 default:
801 // Other VkImageLayout values do not have VUs defined in this context.
802 break;
803 }
804
Dave Houlton8e9f6542018-05-18 12:18:22 -0600805 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600806 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 +0200807 HandleToUint64(img_barrier.image), msg_code,
808 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
809 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
810 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700811 }
812 return skip;
813}
814
815// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600816bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
817 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700818 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700819
Petr Krausad0096a2019-08-09 18:35:04 +0200820 // Scoreboard for checking for duplicate and inconsistent barriers to images
821 struct ImageBarrierScoreboardEntry {
822 uint32_t index;
823 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
824 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
825 const VkImageMemoryBarrier *barrier;
826 };
827 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
828 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
829
John Zulauf463c51e2018-05-31 13:29:20 -0600830 // Scoreboard for duplicate layout transition barriers within the list
831 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
832 ImageBarrierScoreboardImageMap layout_transitions;
833
Mike Weiblen62d08a32017-03-07 22:18:27 -0700834 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200835 const auto &img_barrier = pImageMemoryBarriers[i];
836 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700837
John Zulauf463c51e2018-05-31 13:29:20 -0600838 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
839 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
840 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200841 if (img_barrier.oldLayout != img_barrier.newLayout) {
842 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
843 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600844 if (image_it != layout_transitions.end()) {
845 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200846 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600847 if (subres_it != subres_map.end()) {
848 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200849 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
850 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
851 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600852 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700853 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
854 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200855 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600856 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
857 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200858 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
859 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
860 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600861 }
862 entry = new_entry;
863 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200864 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600865 }
866 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200867 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600868 }
869 }
870
Petr Krausad0096a2019-08-09 18:35:04 +0200871 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600872 if (image_state) {
873 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200874 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
875 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600876
877 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
878 if (image_state->layout_locked) {
879 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600880 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700881 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200882 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600883 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600884 " 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 +0200885 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
886 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600887 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600888
John Zulaufa4472282019-08-22 14:44:34 -0600889 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600890 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600891 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200892 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700893 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600894 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
895 skip |=
896 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
897 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03319",
898 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600899 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200900 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600901 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600902 }
903 } else {
904 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
905 if ((aspect_mask & ds_mask) != (ds_mask)) {
906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
907 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03320",
908 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
909 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
910 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
911 string_VkFormat(image_create_info.format), aspect_mask);
912 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700913 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700914 }
John Zulauff660ad62019-03-23 07:16:05 -0600915
Petr Krausad0096a2019-08-09 18:35:04 +0200916 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
917 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600918 // TODO: Set memory invalid which is in mem_tracker currently
919 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
920 // subresource.
921 } else if (subresource_map) {
922 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600923 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200924 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600925 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600926 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200927 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600928 subres_skip =
929 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
930 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600931 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
John Zulauff660ad62019-03-23 07:16:05 -0600932 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200933 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
934 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600935 string_VkImageLayout(layout_check.layout));
936 }
937 return !subres_skip;
938 };
939 subresource_map->ForRange(normalized_isr, subres_callback);
940 skip |= subres_skip;
941 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700942 }
943 }
944 return skip;
945}
946
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600947bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200948 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700949
Jeff Bolz6835fda2019-10-06 00:15:34 -0500950 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200951 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700952}
953
John Zulauf6b4aae82018-05-09 13:03:36 -0600954template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600955bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
956 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600957 using BarrierRecord = QFOTransferBarrier<Barrier>;
958 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500959 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600960 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
961 const char *barrier_name = BarrierRecord::BarrierName();
962 const char *handle_name = BarrierRecord::HandleName();
963 const char *transfer_type = nullptr;
964 for (uint32_t b = 0; b < barrier_count; b++) {
965 if (!IsTransferOp(&barriers[b])) continue;
966 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700967 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600968 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600969 const auto found = barrier_sets.release.find(barriers[b]);
970 if (found != barrier_sets.release.cend()) {
971 barrier_record = &(*found);
972 transfer_type = "releasing";
973 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600974 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600975 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600976 const auto found = barrier_sets.acquire.find(barriers[b]);
977 if (found != barrier_sets.acquire.cend()) {
978 barrier_record = &(*found);
979 transfer_type = "acquiring";
980 }
981 }
982 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700983 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
984 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
985 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
986 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
987 func_name, barrier_name, b, transfer_type, handle_name,
988 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
989 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600990 }
991 }
992 return skip;
993}
994
John Zulaufa4472282019-08-22 14:44:34 -0600995VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
996 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
997}
998
999const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
1000 return device_state.GetImageState(barrier.image);
1001}
1002
1003VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1004 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1005}
1006
1007const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1008 return device_state.GetBufferState(barrier.buffer);
1009}
1010
1011VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1012
John Zulauf6b4aae82018-05-09 13:03:36 -06001013template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001014void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1015 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001016 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001017 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1018 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001019 auto &barrier = barriers[b];
1020 if (IsTransferOp(&barrier)) {
1021 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
1022 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
1023 barrier_sets.release.emplace(barrier);
1024 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
1025 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1026 barrier_sets.acquire.emplace(barrier);
1027 }
1028 }
1029
1030 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1031 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1032 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1033 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1034 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1035 auto handle_state = BarrierHandleState(*this, barrier);
1036 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1037 if (!mode_concurrent) {
1038 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001039 cb_state->queue_submit_functions.emplace_back(
1040 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1041 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1042 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1043 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001044 });
1045 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001046 }
1047 }
1048}
1049
John Zulaufa4472282019-08-22 14:44:34 -06001050bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001051 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001052 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001053 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001054 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001055 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1056 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001057 return skip;
1058}
1059
John Zulaufa4472282019-08-22 14:44:34 -06001060void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1061 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1062 const VkImageMemoryBarrier *pImageMemBarriers) {
1063 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1064 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001065}
1066
1067template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001068bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001069 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001070 // Record to the scoreboard or report that we have a duplication
1071 bool skip = false;
1072 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1073 if (!inserted.second && inserted.first->second != cb_state) {
1074 // 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 -07001075 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1076 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1077 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -06001078 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -07001079 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1080 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001081 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001082 }
1083 return skip;
1084}
1085
1086template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001087bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1088 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001089 using BarrierRecord = QFOTransferBarrier<Barrier>;
1090 using TypeTag = typename BarrierRecord::Tag;
1091 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001092 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001093 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001094 const char *barrier_name = BarrierRecord::BarrierName();
1095 const char *handle_name = BarrierRecord::HandleName();
1096 // No release should have an extant duplicate (WARNING)
1097 for (const auto &release : cb_barriers.release) {
1098 // Check the global pending release barriers
1099 const auto set_it = global_release_barriers.find(release.handle);
1100 if (set_it != global_release_barriers.cend()) {
1101 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1102 const auto found = set_for_handle.find(release);
1103 if (found != set_for_handle.cend()) {
1104 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1105 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001106 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001107 " to dstQueueFamilyIndex %" PRIu32
1108 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001109 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001110 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1111 }
1112 }
1113 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1114 }
1115 // Each acquire must have a matching release (ERROR)
1116 for (const auto &acquire : cb_barriers.acquire) {
1117 const auto set_it = global_release_barriers.find(acquire.handle);
1118 bool matching_release_found = false;
1119 if (set_it != global_release_barriers.cend()) {
1120 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1121 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1122 }
1123 if (!matching_release_found) {
1124 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1125 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001126 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1127 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1128 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001129 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1130 }
1131 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1132 }
1133 return skip;
1134}
1135
John Zulauf3b04ebd2019-07-18 14:08:11 -06001136bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001137 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001138 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001139 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001140 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1141 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001142 return skip;
1143}
1144
1145template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001146void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001147 using BarrierRecord = QFOTransferBarrier<Barrier>;
1148 using TypeTag = typename BarrierRecord::Tag;
1149 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001150 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001151
1152 // Add release barriers from this submit to the global map
1153 for (const auto &release : cb_barriers.release) {
1154 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1155 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1156 global_release_barriers[release.handle].insert(release);
1157 }
1158
1159 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1160 for (const auto &acquire : cb_barriers.acquire) {
1161 // NOTE: We're not using [] because we don't want to create entries for missing releases
1162 auto set_it = global_release_barriers.find(acquire.handle);
1163 if (set_it != global_release_barriers.end()) {
1164 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1165 set_for_handle.erase(acquire);
1166 if (set_for_handle.size() == 0) { // Clean up empty sets
1167 global_release_barriers.erase(set_it);
1168 }
1169 }
1170 }
1171}
1172
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001173void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001174 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1175 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001176}
1177
John Zulauf6b4aae82018-05-09 13:03:36 -06001178// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001179void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001180
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001181void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001182 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001183 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001184 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001185
Chris Forbes4de4b132017-08-21 11:27:08 -07001186 // For ownership transfers, the barrier is specified twice; as a release
1187 // operation on the yielding queue family, and as an acquire operation
1188 // on the acquiring queue family. This barrier may also include a layout
1189 // transition, which occurs 'between' the two operations. For validation
1190 // purposes it doesn't seem important which side performs the layout
1191 // transition, but it must not be performed twice. We'll arbitrarily
1192 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001193 //
1194 // However, we still need to record initial layout for the "initial layout" validation
1195 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001196
Petr Krausad0096a2019-08-09 18:35:04 +02001197 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001198 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001199 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001200 for (const auto &image : image_state->aliasing_images) {
1201 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001202 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001203 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001204 }
1205}
1206
unknown86bcb3a2019-07-11 13:05:36 -06001207void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001208 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001209 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1210 const auto &image_create_info = image_state->createInfo;
1211
1212 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1213 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1214 // for all (potential) layer sub_resources.
1215 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1216 normalized_isr.baseArrayLayer = 0;
1217 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1218 }
1219
John Zulauf2be3fe02019-12-30 09:48:02 -07001220 if (is_release_op) {
1221 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1222 } else {
1223 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1224 }
unknown86bcb3a2019-07-11 13:05:36 -06001225}
1226
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001227bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1228 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1229 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1230 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001231 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001232 assert(cb_node);
1233 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001234 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001235 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001236
John Zulauff660ad62019-03-23 07:16:05 -06001237 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1238 if (subresource_map) {
1239 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001240 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1241 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001242 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001243 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001244 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001245 subres_skip |=
1246 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1247 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001248 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001249 "%s layout %s.",
1250 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1251 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001252 }
John Zulauff660ad62019-03-23 07:16:05 -06001253 return !subres_skip;
1254 };
1255 subresource_map->ForRange(range, subresource_cb);
1256 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001257 }
John Zulauff660ad62019-03-23 07:16:05 -06001258
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001259 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1260 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1261 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001262 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1263 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001264 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001265 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001266 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001267 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001268 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001269 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001270 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001271 if (image_state->shared_presentable) {
1272 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001273 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1274 layout_invalid_msg_code,
1275 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1276 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001277 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001278 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001279 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001280 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001281 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 -07001282 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001283 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001284 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1285 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001286 }
1287 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001288 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001289}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001290bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001291 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1292 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001293 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001294 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1295 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1296}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001297
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001298void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001299 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001300 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001301 if (!renderPass) return;
1302
Tobias Hectorbbb12282018-10-22 15:17:59 +01001303 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001304 if (framebuffer_state) {
1305 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001306 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001307 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001308 VkImageLayout stencil_layout = kInvalidLayout;
1309 const auto *attachment_description_stencil_layout =
1310 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1311 if (attachment_description_stencil_layout) {
1312 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1313 }
1314
1315 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001316 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001317 }
1318 }
1319}
Dave Houltone19e20d2018-02-02 16:32:41 -07001320
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001321#ifdef VK_USE_PLATFORM_ANDROID_KHR
1322// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1323// This could also move into a seperate core_validation_android.cpp file... ?
1324
1325//
1326// AHB-specific validation within non-AHB APIs
1327//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001328bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001329 bool skip = false;
1330
1331 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1332 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001333 if (0 != ext_fmt_android->externalFormat) {
1334 if (VK_FORMAT_UNDEFINED != create_info->format) {
1335 skip |=
1336 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1337 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001338 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001339 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1340 }
1341
1342 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1344 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001346 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1347 }
1348
1349 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1350 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1351 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001352 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001353 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1354 }
1355
1356 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1357 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1358 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001359 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001360 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1361 }
1362 }
1363
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001364 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1366 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001367 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001368 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1369 }
1370 }
1371
Dave Houltond9611312018-11-19 17:03:36 -07001372 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001373 if (VK_FORMAT_UNDEFINED == create_info->format) {
1374 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1375 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001376 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001377 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1378 }
1379 }
1380
1381 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1382 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1383 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001384 skip |=
1385 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1386 "VUID-VkImageCreateInfo-pNext-02393",
1387 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1388 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1389 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001390 }
1391
1392 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1393 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1394 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001395 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001396 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1397 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1398 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1399 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001400 }
1401
1402 return skip;
1403}
1404
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001405bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001406 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001407 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001408
1409 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001410 if (VK_FORMAT_UNDEFINED != create_info->format) {
1411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1412 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1413 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1414 "format member is %s.",
1415 string_VkFormat(create_info->format));
1416 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001417
Dave Houltond9611312018-11-19 17:03:36 -07001418 // Chain must include a compatible ycbcr conversion
1419 bool conv_found = false;
1420 uint64_t external_format = 0;
1421 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1422 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001423 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001424 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001425 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001426 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 }
Dave Houltond9611312018-11-19 17:03:36 -07001428 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001429 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001430 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 -07001431 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1432 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1433 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1434 }
1435
1436 // Errors in create_info swizzles
1437 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1438 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1439 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1440 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1442 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1443 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1444 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445 }
1446 }
Dave Houltond9611312018-11-19 17:03:36 -07001447
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001448 return skip;
1449}
1450
John Zulaufa26d3c82019-08-14 16:09:08 -06001451bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001452 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001453
John Zulaufa26d3c82019-08-14 16:09:08 -06001454 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001455 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1456 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1457 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001458 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001459 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1460 "bound to memory.");
1461 }
1462 return skip;
1463}
1464
1465#else
1466
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001467bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001468 return false;
1469}
1470
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001471bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001472
John Zulaufa26d3c82019-08-14 16:09:08 -06001473bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001474
1475#endif // VK_USE_PLATFORM_ANDROID_KHR
1476
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001477bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001478 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001479 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001480
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001481 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001482 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001483 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1484 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1485 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1486 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001487 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001488 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001489 }
1490
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001491 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1492 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1493 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1494 "VUID-VkImageCreateInfo-flags-00949",
1495 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1496 "flag bit is set");
1497 }
1498
1499 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1501 "VUID-VkImageCreateInfo-imageType-00954",
1502 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1503 "height (%d) and arrayLayers (%d) must be >= 6.",
1504 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1505 }
Dave Houlton130c0212018-01-29 13:39:56 -07001506 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001507
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001508 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001509 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1510 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1511 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001512 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 +00001513 "VUID-VkImageCreateInfo-usage-00964",
1514 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1515 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001516 }
1517
1518 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001519 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 +00001520 "VUID-VkImageCreateInfo-usage-00965",
1521 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1522 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001523 }
1524
ByumjinConffx991b6062019-08-14 15:17:53 -07001525 if (device_extensions.vk_ext_fragment_density_map) {
1526 uint32_t ceiling_width =
1527 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1528 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1529 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1530 skip |=
1531 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1532 "VUID-VkImageCreateInfo-usage-02559",
1533 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1534 "ceiling of device "
1535 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1536 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1537 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1538 }
1539
1540 uint32_t ceiling_height =
1541 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1542 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1543 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1544 skip |=
1545 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1546 "VUID-VkImageCreateInfo-usage-02560",
1547 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1548 "ceiling of device "
1549 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1550 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1551 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1552 }
1553 }
1554
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001555 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001556 VkResult result = VK_SUCCESS;
1557 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1558 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1559 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1560 &format_limits);
1561 } else {
1562 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1563 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1564 image_format_info.type = pCreateInfo->imageType;
1565 image_format_info.tiling = pCreateInfo->tiling;
1566 image_format_info.usage = pCreateInfo->usage;
1567 image_format_info.flags = pCreateInfo->flags;
1568 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1569 format_limits = image_format_properties.imageFormatProperties;
1570 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001571
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001572 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001573#ifdef VK_USE_PLATFORM_ANDROID_KHR
1574 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1575#endif // VK_USE_PLATFORM_ANDROID_KHR
1576 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1577 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1578 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001579 } else {
1580 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1581 const char *format_string = string_VkFormat(pCreateInfo->format);
1582 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1583 "VUID-VkImageCreateInfo-mipLevels-02255",
1584 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1585 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1586 }
Dave Houlton130c0212018-01-29 13:39:56 -07001587
Dave Houltona585d132019-01-18 13:05:42 -07001588 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1589 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1590 (uint64_t)pCreateInfo->samples;
1591 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001592
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001593 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001594 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001595 uint64_t ig_mask = imageGranularity - 1;
1596 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001597
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001598 if (total_size > format_limits.maxResourceSize) {
1599 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1600 kVUID_Core_Image_InvalidFormatLimitsViolation,
1601 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1602 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1603 total_size, format_limits.maxResourceSize);
1604 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001605
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001606 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1607 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1608 "VUID-VkImageCreateInfo-arrayLayers-02256",
1609 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1610 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1611 }
1612
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001613 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1614 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001615 skip |= log_msg(
1616 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1617 "VUID-VkImageCreateInfo-format-02653",
1618 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1619 pCreateInfo->arrayLayers);
1620 }
1621
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001622 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1623 skip |=
1624 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1625 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001626 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001627 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001628 }
1629
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001630 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001631 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 -06001632 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001633 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1634 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001635 }
1636
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001637 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001638 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1639 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1640 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1641 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001642 skip |=
1643 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1644 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1645 "format must be block, ETC or ASTC compressed, but is %s",
1646 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001647 }
1648 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1649 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001650 skip |=
1651 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1652 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1653 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001654 }
1655 }
1656 }
1657
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001658 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001659 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1660 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1661 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001662 }
1663
unknown2c877272019-07-11 12:56:50 -06001664 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1665 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1666 skip |=
1667 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1668 "VUID-VkImageCreateInfo-format-01577",
1669 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1670 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1671 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001672 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001673}
1674
John Zulauf7eeb6f72019-06-17 11:56:36 -06001675void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1676 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1677 if (VK_SUCCESS != result) return;
1678
1679 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1680
1681 IMAGE_LAYOUT_STATE image_state;
1682 image_state.layout = pCreateInfo->initialLayout;
1683 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001684 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001685 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001686 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001687}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001688
Jeff Bolz5c801d12019-10-09 10:38:45 -05001689bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001690 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001691 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001692 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001693 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001694 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001695 }
1696 return skip;
1697}
1698
John Zulauf7eeb6f72019-06-17 11:56:36 -06001699void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1700 // Clean up validation specific data
1701 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001702
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001703 const auto &sub_entry = imageSubresourceMap.find(image);
1704 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001705 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001706 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001707 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001708 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001709 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001710
1711 // Clean up generic image state
1712 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001713}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001714
John Zulauf07288512019-07-05 11:09:50 -06001715bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001716 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001717
1718 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1719 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1720 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 -06001721 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001722 }
1723
Dave Houlton1d2022c2017-03-29 11:43:58 -06001724 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001725 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1726 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 -06001727 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001728 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001729 char const str[] = "vkCmdClearColorImage called with compressed image.";
1730 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 -06001731 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001732 }
1733
1734 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1735 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1736 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 -06001737 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001738 }
1739 return skip;
1740}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001741
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001742uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1743 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1744 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001745 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001746 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001747 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001748 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001749}
1750
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001751uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1752 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1753 uint32_t array_layer_count = range->layerCount;
1754 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1755 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001756 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001757 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001758}
1759
John Zulauf07288512019-07-05 11:09:50 -06001760bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1761 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1762 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001763 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001764 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1765 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001766 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 -07001767 HandleToUint64(image_state->image), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001768 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1769 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001770 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001771
1772 } else {
1773 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1774 if (!device_extensions.vk_khr_shared_presentable_image) {
1775 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
1776 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1777 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-00005",
1778 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1779 string_VkImageLayout(dest_image_layout));
1780 }
1781 } else {
1782 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1783 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
1784 skip |= log_msg(
1785 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1786 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-01394",
1787 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1788 func_name, string_VkImageLayout(dest_image_layout));
1789 }
1790 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001791 }
1792
John Zulauff660ad62019-03-23 07:16:05 -06001793 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001794 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001795 if (subresource_map) {
1796 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001797 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001798 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001799 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001800 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001801 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001802 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1803 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1804 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1805 } else {
1806 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001807 }
John Zulauff660ad62019-03-23 07:16:05 -06001808 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1809 HandleToUint64(cb_node->commandBuffer), error_code,
1810 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1811 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1812 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001813 }
John Zulauff660ad62019-03-23 07:16:05 -06001814 return !subres_skip;
1815 };
1816 subresource_map->ForRange(normalized_isr, subres_callback);
1817 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001818 }
1819
1820 return skip;
1821}
1822
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001823bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1824 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001825 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001826 bool skip = false;
1827 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001828 const auto *cb_node = GetCBState(commandBuffer);
1829 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001830 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001831 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001832 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001833 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001834 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001835 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001836 skip |=
1837 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1838 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001839 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001840 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001841 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001842 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001843 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001844 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1845 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001846 }
1847 }
1848 return skip;
1849}
1850
John Zulaufeabb4462019-07-05 14:13:03 -06001851void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1852 const VkClearColorValue *pColor, uint32_t rangeCount,
1853 const VkImageSubresourceRange *pRanges) {
1854 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1855
1856 auto cb_node = GetCBState(commandBuffer);
1857 auto image_state = GetImageState(image);
1858 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001859 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001860 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001861 }
1862 }
1863}
1864
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001865bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1866 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001867 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001868 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001869
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001870 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001871 const auto *cb_node = GetCBState(commandBuffer);
1872 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001873 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001874 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001875 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001876 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001877 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001878 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001879 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001880 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1881 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001882 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001883 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001884 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001885 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001886 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001887 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001888 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001889 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001890 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1891 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001892 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001893 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1894 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001895 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 -06001896 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001897 }
1898 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001899 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001900 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001901 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 -06001902 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001903 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001904 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1905 char const str[] =
1906 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1907 "set.";
1908 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 -06001909 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001910 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001911 }
1912 return skip;
1913}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001914
John Zulaufeabb4462019-07-05 14:13:03 -06001915void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1916 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1917 const VkImageSubresourceRange *pRanges) {
1918 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1919 auto cb_node = GetCBState(commandBuffer);
1920 auto image_state = GetImageState(image);
1921 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001922 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001923 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001924 }
1925 }
1926}
1927
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001928// Returns true if [x, xoffset] and [y, yoffset] overlap
1929static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1930 bool result = false;
1931 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1932 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1933
1934 if (intersection_max > intersection_min) {
1935 result = true;
1936 }
1937 return result;
1938}
1939
Dave Houltonc991cc92018-03-06 11:08:51 -07001940// Returns true if source area of first copy region intersects dest area of second region
1941// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1942static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001943 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001944
Dave Houltonc991cc92018-03-06 11:08:51 -07001945 // Separate planes within a multiplane image cannot intersect
1946 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001947 return result;
1948 }
1949
Dave Houltonc991cc92018-03-06 11:08:51 -07001950 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1951 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1952 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001953 result = true;
1954 switch (type) {
1955 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001956 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001957 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001958 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001959 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001960 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001961 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001962 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001963 break;
1964 default:
1965 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1966 assert(false);
1967 }
1968 }
1969 return result;
1970}
1971
Dave Houltonfc1a4052017-04-27 14:32:45 -06001972// Returns non-zero if offset and extent exceed image extents
1973static const uint32_t x_bit = 1;
1974static const uint32_t y_bit = 2;
1975static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001976static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001978 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001979 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1980 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001982 }
1983 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1984 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001985 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001986 }
1987 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1988 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001989 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001990 }
1991 return result;
1992}
1993
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001994// Test if two VkExtent3D structs are equivalent
1995static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1996 bool result = true;
1997 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1998 (extent->depth != other_extent->depth)) {
1999 result = false;
2000 }
2001 return result;
2002}
2003
Dave Houltonee281a52017-12-08 13:51:02 -07002004// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2005// Destination image texel extents must be adjusted by block size for the dest validation checks
2006VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2007 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002008 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2009 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002010 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002011 adjusted_extent.width /= block_size.width;
2012 adjusted_extent.height /= block_size.height;
2013 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002014 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2015 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002016 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002017 adjusted_extent.width *= block_size.width;
2018 adjusted_extent.height *= block_size.height;
2019 adjusted_extent.depth *= block_size.depth;
2020 }
2021 return adjusted_extent;
2022}
2023
Dave Houlton6f9059e2017-05-02 17:15:13 -06002024// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002025static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2026 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002027
2028 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002029 if (mip >= img->createInfo.mipLevels) {
2030 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002031 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002032
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002033 // 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 -06002034 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002035
Dave Houltone48cd112019-01-03 17:01:18 -07002036 // If multi-plane, adjust per-plane extent
2037 if (FormatIsMultiplane(img->createInfo.format)) {
2038 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2039 extent.width /= divisors.width;
2040 extent.height /= divisors.height;
2041 }
2042
Jeff Bolzef40fec2018-09-01 22:04:34 -05002043 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2044 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002045 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002046 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2047 } else {
2048 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2049 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2050 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2051 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002052
Dave Houlton6f9059e2017-05-02 17:15:13 -06002053 // Image arrays have an effective z extent that isn't diminished by mip level
2054 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002055 extent.depth = img->createInfo.arrayLayers;
2056 }
2057
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002058 return extent;
2059}
2060
2061// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002062static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2064}
2065
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002066// Test if the extent argument has any dimensions set to 0.
2067static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2068 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2069}
2070
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002071// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002072VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002073 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2074 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002075 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002076 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002077 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002078 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002079 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002080 granularity.width *= block_size.width;
2081 granularity.height *= block_size.height;
2082 }
2083 }
2084 return granularity;
2085}
2086
2087// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2088static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2089 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002090 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2091 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002092 valid = false;
2093 }
2094 return valid;
2095}
2096
2097// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002098bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002099 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002100 bool skip = false;
2101 VkExtent3D offset_extent = {};
2102 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2103 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2104 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002105 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002106 // 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 -07002107 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002108 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 -04002109 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002110 "%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 "
2111 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002112 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002113 }
2114 } else {
2115 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2116 // integer multiples of the image transfer granularity.
2117 if (IsExtentAligned(&offset_extent, granularity) == 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,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002120 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2121 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002122 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2123 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002124 }
2125 }
2126 return skip;
2127}
2128
2129// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002130bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002131 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002132 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002133 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002134 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002135 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2136 // subresource extent.
2137 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002138 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 -04002139 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002140 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2141 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2142 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2143 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002144 }
2145 } else {
2146 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2147 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2148 // subresource extent dimensions.
2149 VkExtent3D offset_extent_sum = {};
2150 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2151 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2152 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002153 bool x_ok = true;
2154 bool y_ok = true;
2155 bool z_ok = true;
2156 switch (image_type) {
2157 case VK_IMAGE_TYPE_3D:
2158 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2159 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002160 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002161 case VK_IMAGE_TYPE_2D:
2162 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2163 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002164 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002165 case VK_IMAGE_TYPE_1D:
2166 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2167 (subresource_extent->width == offset_extent_sum.width));
2168 break;
2169 default:
2170 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2171 assert(false);
2172 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002173 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002174 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 -04002175 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002176 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2177 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2178 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2179 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2180 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2181 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002182 }
2183 }
2184 return skip;
2185}
2186
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002187bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002188 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002189 bool skip = false;
2190 if (mip_level >= img->createInfo.mipLevels) {
2191 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2192 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002193 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2194 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002195 }
2196 return skip;
2197}
2198
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002199bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002200 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002201 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002202 bool skip = false;
2203 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2204 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2205 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2206 HandleToUint64(cb_node->commandBuffer), vuid,
2207 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002208 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002209 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2210 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002211 }
2212 return skip;
2213}
2214
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002215// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002216bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002217 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002218 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002219 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002220 VkExtent3D granularity = GetScaledItg(cb_node, img);
2221 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002222 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002223 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002224 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002225 return skip;
2226}
2227
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002228// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002229bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002230 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002231 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002232 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002233 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002234 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2235 skip |=
2236 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002238 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002239 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2240 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002241
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002242 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002243 granularity = GetScaledItg(cb_node, dst_img);
2244 skip |=
2245 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002246 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002247 const VkExtent3D dest_effective_extent =
2248 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002250 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002251 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002252 return skip;
2253}
2254
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002256bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002257 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 bool skip = false;
2259
2260 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002261 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002262
2263 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002264 const VkExtent3D src_copy_extent = region.extent;
2265 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002266 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2267
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 bool slice_override = false;
2269 uint32_t depth_slices = 0;
2270
2271 // Special case for copying between a 1D/2D array and a 3D image
2272 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2273 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002274 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 slice_override = (depth_slices != 1);
2276 } 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 -07002277 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002278 slice_override = (depth_slices != 1);
2279 }
2280
2281 // Do all checks on source image
2282 //
2283 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002284 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2285 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 -06002286 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002287 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002288 "be 0 and 1, respectively.",
2289 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002290 }
2291 }
2292
Dave Houlton533be9f2018-03-26 17:08:30 -06002293 // VUID-VkImageCopy-srcImage-01785
2294 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2295 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 -06002296 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002297 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002298 "these must be 0 and 1, respectively.",
2299 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 }
2301
Dave Houlton533be9f2018-03-26 17:08:30 -06002302 // VUID-VkImageCopy-srcImage-01787
2303 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2304 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-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002306 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2307 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002308 }
2309
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002310 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002312 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002313 skip |=
2314 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002315 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002316 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002317 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2318 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002319 }
2320 }
2321 } else { // Pre maint 1
2322 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002323 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002324 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 -06002325 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002326 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2327 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002328 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2329 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 }
2331 }
2332 }
2333
Dave Houltonc991cc92018-03-06 11:08:51 -07002334 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002335 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002336 if (FormatIsCompressed(src_state->createInfo.format) ||
2337 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002338 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002339 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002340 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2341 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2342 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002343 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002344 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 -07002345 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002348 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002349 }
2350
Dave Houlton94a00372017-12-14 15:08:47 -07002351 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002352 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2353 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002354 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002355 skip |=
2356 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002357 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002358 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002359 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002360 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002361 }
2362
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002363 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002364 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2365 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002366 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002367 skip |=
2368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002369 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002370 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002371 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002372 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002373 }
2374
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002375 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002376 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2377 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002378 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002379 skip |=
2380 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002381 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002382 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002383 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002384 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002385 }
2386 } // Compressed
2387
2388 // Do all checks on dest image
2389 //
2390 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002391 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002392 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 -06002393 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002394 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002395 "these must be 0 and 1, respectively.",
2396 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002397 }
2398 }
2399
Dave Houlton533be9f2018-03-26 17:08:30 -06002400 // VUID-VkImageCopy-dstImage-01786
2401 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2402 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 -06002403 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002404 "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 -06002405 "and 1, respectively.",
2406 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002407 }
2408
2409 // VUID-VkImageCopy-dstImage-01788
2410 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2411 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 -06002412 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002413 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2414 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002415 }
2416
2417 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002418 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002419 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 -06002420 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002421 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002422 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2423 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002424 }
2425 }
2426 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002427 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002429 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002430 skip |=
2431 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002432 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002433 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002434 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2435 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 }
2437 }
2438 } else { // Pre maint 1
2439 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002440 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002441 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 -06002442 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002443 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2444 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002445 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2446 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002447 }
2448 }
2449 }
2450
Dave Houltonc991cc92018-03-06 11:08:51 -07002451 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2452 if (FormatIsCompressed(dst_state->createInfo.format) ||
2453 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002454 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002455
2456 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002457 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2458 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2459 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002460 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002461 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 -07002462 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002463 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002464 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002465 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466 }
2467
Dave Houlton94a00372017-12-14 15:08:47 -07002468 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002469 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2470 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002471 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002472 skip |=
2473 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002474 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002475 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002476 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002477 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002478 }
2479
Dave Houltonee281a52017-12-08 13:51:02 -07002480 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2481 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2482 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002483 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002484 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 -07002485 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002486 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2487 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002488 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002489 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002490 }
2491
Dave Houltonee281a52017-12-08 13:51:02 -07002492 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2493 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2494 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002495 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002496 skip |=
2497 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002498 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002499 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002500 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002501 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002502 }
2503 } // Compressed
2504 }
2505 return skip;
2506}
2507
Dave Houltonc991cc92018-03-06 11:08:51 -07002508// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002509bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002510 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002511 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002512
2513 // Neither image is multiplane
2514 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2515 // If neither image is multi-plane the aspectMask member of src and dst must match
2516 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2517 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002518 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002519 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2520 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 -06002521 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002522 }
2523 } else {
2524 // Source image multiplane checks
2525 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2526 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2527 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2528 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002529 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002530 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 -06002531 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002532 }
2533 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2534 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2535 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002536 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002537 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 -06002538 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002539 }
2540 // Single-plane to multi-plane
2541 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2542 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2543 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002544 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002545 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 -06002546 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002547 }
2548
2549 // Dest image multiplane checks
2550 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2551 aspect = region.dstSubresource.aspectMask;
2552 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2553 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002554 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002555 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 -06002556 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002557 }
2558 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2559 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2560 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002561 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002562 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 -06002563 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002564 }
2565 // Multi-plane to single-plane
2566 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2567 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2568 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002569 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002570 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 -06002571 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002572 }
2573 }
2574
2575 return skip;
2576}
2577
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002578bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2579 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002580 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002581 const auto *cb_node = GetCBState(commandBuffer);
2582 const auto *src_image_state = GetImageState(srcImage);
2583 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002584 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002585
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002586 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002587
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002588 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2589
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002590 for (uint32_t i = 0; i < regionCount; i++) {
2591 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002592
2593 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2594 VkExtent3D src_copy_extent = region.extent;
2595 VkExtent3D dst_copy_extent =
2596 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2597
Dave Houlton6f9059e2017-05-02 17:15:13 -06002598 bool slice_override = false;
2599 uint32_t depth_slices = 0;
2600
2601 // Special case for copying between a 1D/2D array and a 3D image
2602 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2603 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2604 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002605 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002606 slice_override = (depth_slices != 1);
2607 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2608 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002609 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002610 slice_override = (depth_slices != 1);
2611 }
2612
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002613 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2614 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2615 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002616 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002617 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002618 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002619 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002620 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2621 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002622 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002623 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2624 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002625
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002626 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002627 // No chance of mismatch if we're overriding depth slice count
2628 if (!slice_override) {
2629 // The number of depth slices in srcSubresource and dstSubresource must match
2630 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2631 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002632 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2633 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002634 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002635 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2636 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002637 if (src_slices != dst_slices) {
2638 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002639 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002640 << "] do not match";
2641 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 -06002642 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002643 }
2644 }
2645 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002646 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002647 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002648 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002649 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002650 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002651 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 -06002652 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002653 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002654 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002655
Dave Houltonc991cc92018-03-06 11:08:51 -07002656 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002657 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002658 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002659 }
2660
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002661 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002662 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2663 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002664 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002665 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 -06002666 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002667 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002668 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002669
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002670 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002671 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002672 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002673 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002674 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2675 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 -06002676 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002677 }
2678
2679 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002680 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002681 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002682 ss << "vkCmdCopyImage(): pRegion[" << i
2683 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002684 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 -06002685 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002686 }
2687
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002688 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2689 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2690 // 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 -07002691 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2692 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002693 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002694 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002695 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2696 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2697 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002698 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 -06002699 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002700 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002701
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002702 // 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 -07002703 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2704 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002705 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002706 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002707 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2708 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2709 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002710 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 -06002711 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002712 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002713 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002714
Dave Houltonfc1a4052017-04-27 14:32:45 -06002715 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002716 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2717 if (slice_override) src_copy_extent.depth = depth_slices;
2718 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002719 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002720 skip |=
2721 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2722 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2723 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2724 "width [%1d].",
2725 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002726 }
2727
2728 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002729 skip |=
2730 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2731 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2732 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2733 "height [%1d].",
2734 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002735 }
2736 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002737 skip |=
2738 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2739 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2740 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2741 "depth [%1d].",
2742 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002743 }
2744
Dave Houltonee281a52017-12-08 13:51:02 -07002745 // Adjust dest extent if necessary
2746 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2747 if (slice_override) dst_copy_extent.depth = depth_slices;
2748
2749 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002750 if (extent_check & x_bit) {
2751 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 -06002752 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002753 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002754 "width [%1d].",
2755 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002756 }
2757 if (extent_check & y_bit) {
2758 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 -06002759 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002760 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002761 "height [%1d].",
2762 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002763 }
2764 if (extent_check & z_bit) {
2765 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 -06002766 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002767 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002768 "depth [%1d].",
2769 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002770 }
2771
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002772 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2773 // must not overlap in memory
2774 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002775 for (uint32_t j = 0; j < regionCount; j++) {
2776 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002777 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002778 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002779 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002780 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 -06002781 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002782 }
2783 }
2784 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002785 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002786
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002787 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2788 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2789 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002790 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002791 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2792 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002793 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 -06002794 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002795 }
2796 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002797 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002798 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2799 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 -06002800 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002801 }
2802 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002803
Dave Houlton33c22b72017-02-28 13:16:02 -07002804 // Source and dest image sample counts must match
2805 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2806 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2807 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 -06002808 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002809 }
2810
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002811 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2812 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002813 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002814 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2815 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2816 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2817 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002818 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002819 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2820 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2821 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2822 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002823 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002824 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002825 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002826 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2827 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002828 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002829 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2830 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2831 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2832 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2833 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2834 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002835 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002836 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002837 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2838 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002839 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002840 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2841 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002842 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2843 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002844 }
2845
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002846 return skip;
2847}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002848
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002849void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2850 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2851 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002852 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2853 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002854 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002855 auto src_image_state = GetImageState(srcImage);
2856 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002857
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002858 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002859 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002860 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2861 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002862 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002863}
2864
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002865// Returns true if sub_rect is entirely contained within rect
2866static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2867 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2868 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2869 return false;
2870 return true;
2871}
2872
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002873bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002874 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2875 const VkRect2D &render_area, uint32_t rect_count,
2876 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002877 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002878 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2879 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002880 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002881 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002882
2883 for (uint32_t j = 0; j < rect_count; j++) {
2884 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002885 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 -07002886 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2887 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2888 "the current render pass instance.",
2889 j);
2890 }
2891
2892 if (image_view_state) {
2893 // The layers specified by a given element of pRects must be contained within every attachment that
2894 // pAttachments refers to
2895 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2896 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2897 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002898 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2899 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2900 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2901 "of pAttachment[%d].",
2902 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002903 }
2904 }
2905 }
2906 return skip;
2907}
2908
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002909bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2910 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002911 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002912 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002913 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002914 if (!cb_node) return skip;
2915
2916 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2917 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2918 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002919 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002920
2921 // Validate that attachment is in reference list of active subpass
2922 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002923 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002924 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002925 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002926 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002927 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002928
John Zulauf3a548ef2019-02-01 16:14:07 -07002929 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2930 auto clear_desc = &pAttachments[attachment_index];
2931 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002932
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002933 if (0 == clear_desc->aspectMask) {
2934 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 -06002935 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002936 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2937 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 -06002938 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002939 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002940 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2941 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2942 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2943 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002944 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2945 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2946 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2947 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2948 attachment_index, clear_desc->colorAttachment,
2949 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2950 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2951 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002952
John Zulauff2582972019-02-09 14:53:30 -07002953 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2954 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002955 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2957 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002958 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002959 " subpass %u. colorAttachmentCount=%u",
2960 attachment_index, clear_desc->colorAttachment,
2961 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2962 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002963 }
John Zulauff2582972019-02-09 14:53:30 -07002964 fb_attachment = color_attachment;
2965
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002966 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2967 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2968 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002969 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002970 skip |=
2971 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2972 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002973 }
2974 } else { // Must be depth and/or stencil
2975 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2976 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002977 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002978 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 -07002979 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2980 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002981 }
2982 if (!subpass_desc->pDepthStencilAttachment ||
2983 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2984 skip |= log_msg(
2985 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002986 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002987 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002988 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002989 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002990 }
2991 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002992 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002993 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2994 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002995 }
2996 }
2997 }
2998 return skip;
2999}
3000
3001void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3002 const VkClearAttachment *pAttachments, uint32_t rectCount,
3003 const VkClearRect *pRects) {
3004 auto *cb_node = GetCBState(commandBuffer);
3005 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3006 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3007 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3008 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3009 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3010 const auto clear_desc = &pAttachments[attachment_index];
3011 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3012 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3013 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3014 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3015 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3016 subpass_desc->pDepthStencilAttachment) {
3017 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3018 }
3019 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003020 if (!clear_rect_copy) {
3021 // We need a copy of the clear rectangles that will persist until the last lambda executes
3022 // but we want to create it as lazily as possible
3023 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003024 }
John Zulauf441558b2019-08-12 11:47:39 -06003025 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3026 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003027 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003028 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003029 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003030 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003031 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3032 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003033 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3034 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003035 return skip;
3036 };
3037 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003038 }
3039 }
3040 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003041}
3042
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003043bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3044 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003045 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003046 const auto *cb_node = GetCBState(commandBuffer);
3047 const auto *src_image_state = GetImageState(srcImage);
3048 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003049
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003050 bool skip = false;
3051 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003052 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3053 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003054 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003055 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003056 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3057 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003058 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3059 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003060
Cort Stratton7df30962018-05-17 19:45:57 -07003061 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003062 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003063 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003064 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3065 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3066 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003067 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003068 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3069 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003070 // For each region, the number of layers in the image subresource should not be zero
3071 // For each region, src and dest image aspect must be color only
3072 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003073 skip |=
3074 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3075 skip |=
3076 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003077 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003078 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3079 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003080 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003081 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3082 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003083 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3084 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3085 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3086 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3087 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003088 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3089 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003090 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003091 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3092 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003093
3094 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003095 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3096 skip |= log_msg(
3097 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003098 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003099 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003100 }
Cort Stratton7df30962018-05-17 19:45:57 -07003101 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003102 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3103 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3104 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003105 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003106 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 -06003107 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003108 }
3109 }
3110
3111 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3112 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003113 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 -06003114 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003115 }
3116 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3117 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003118 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 -06003119 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003120 }
3121 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3122 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3123 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 -06003124 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003125 }
3126 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3127 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3128 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 -06003129 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003130 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003131 } else {
3132 assert(0);
3133 }
3134 return skip;
3135}
3136
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003137bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3138 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003139 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003140 const auto *cb_node = GetCBState(commandBuffer);
3141 const auto *src_image_state = GetImageState(srcImage);
3142 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003143
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003144 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003145 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003146 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003147 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003148 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003149 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003150 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003151 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003152 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003153 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3154 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003155 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003156 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3157 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003158 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003159 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3160 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003161 skip |=
3162 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003163 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3164 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003165 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003166 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003167 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003168 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003169
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003170 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003171
Dave Houlton33c2d252017-06-09 17:08:32 -06003172 VkFormat src_format = src_image_state->createInfo.format;
3173 VkFormat dst_format = dst_image_state->createInfo.format;
3174 VkImageType src_type = src_image_state->createInfo.imageType;
3175 VkImageType dst_type = dst_image_state->createInfo.imageType;
3176
Cort Stratton186b1a22018-05-01 20:18:06 -04003177 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003178 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003179 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3180 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003181 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003182 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3183 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3184 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003185 }
3186
3187 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3188 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 -06003189 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003190 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003191 }
3192
Dave Houlton33c2d252017-06-09 17:08:32 -06003193 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3194 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3195 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 -06003196 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003197 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003198 }
3199
3200 // Validate consistency for unsigned formats
3201 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3202 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003203 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003204 << "the other one must also have unsigned integer format. "
3205 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3206 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 -06003207 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003208 }
3209
3210 // Validate consistency for signed formats
3211 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3212 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003214 << "the other one must also have signed integer format. "
3215 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3216 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 -06003217 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003218 }
3219
3220 // Validate filter for Depth/Stencil formats
3221 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3222 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003223 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 << "then filter must be VK_FILTER_NEAREST.";
3225 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 -06003226 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003227 }
3228
3229 // Validate aspect bits and formats for depth/stencil images
3230 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3231 if (src_format != dst_format) {
3232 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003233 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 << "stencil, the other one must have exactly the same format. "
3235 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3236 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003237 skip |=
3238 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3239 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003240 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003241 } // Depth or Stencil
3242
3243 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003244 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003245 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003246 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3247 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3248 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003249 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003250 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3251 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003252 for (uint32_t i = 0; i < regionCount; i++) {
3253 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003254 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003255 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003256 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3257 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003258 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003259 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3260 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003261 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3262 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3263 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003264 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003265 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003266 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003267 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003268 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3269 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003270 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003271 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3272 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003273 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003274 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3275 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003276 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003278 skip |=
3279 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3280 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003281 }
Dave Houlton48989f32017-05-26 15:01:46 -06003282 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3283 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003284 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003285 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003286 skip |=
3287 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3288 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003289 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003290
3291 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003292 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003293 skip |= log_msg(
3294 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3295 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3296 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003297 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003298
Dave Houlton48989f32017-05-26 15:01:46 -06003299 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003300 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 -06003301 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003302 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003303 }
Dave Houlton48989f32017-05-26 15:01:46 -06003304
Dave Houlton33c2d252017-06-09 17:08:32 -06003305 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3306 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 -06003307 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003308 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003309 "image format %s.",
3310 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003311 }
3312
3313 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3314 skip |= log_msg(
3315 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003316 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003317 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3318 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003319 }
3320
Dave Houlton48989f32017-05-26 15:01:46 -06003321 // Validate source image offsets
3322 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003323 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003324 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003325 skip |=
3326 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3327 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3328 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3329 "of (%1d, %1d). These must be (0, 1).",
3330 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003331 }
3332 }
3333
Dave Houlton33c2d252017-06-09 17:08:32 -06003334 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003335 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3336 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 -06003337 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003338 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003339 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3340 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003341 }
3342 }
3343
Dave Houlton33c2d252017-06-09 17:08:32 -06003344 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003345 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3346 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003347 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003348 skip |= log_msg(
3349 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3350 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3351 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3352 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003353 }
3354 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3355 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003356 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003357 skip |= log_msg(
3358 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003359 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003360 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003361 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003362 }
3363 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3364 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003365 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003366 skip |= log_msg(
3367 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3368 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3369 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3370 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003371 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003372 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003373 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-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003375 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003376 }
Dave Houlton48989f32017-05-26 15:01:46 -06003377
3378 // Validate dest image offsets
3379 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003380 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003381 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003382 skip |=
3383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3384 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3385 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3386 "(%1d, %1d). These must be (0, 1).",
3387 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003388 }
3389 }
3390
Dave Houlton33c2d252017-06-09 17:08:32 -06003391 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003392 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3393 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 -06003394 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003395 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003396 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3397 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003398 }
3399 }
3400
Dave Houlton33c2d252017-06-09 17:08:32 -06003401 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003402 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3403 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003404 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003405 skip |= log_msg(
3406 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3407 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3408 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3409 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003410 }
3411 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3412 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003413 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003414 skip |= log_msg(
3415 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003416 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003417 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003418 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003419 }
3420 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3421 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003422 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003423 skip |= log_msg(
3424 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3425 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3426 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3427 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003428 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003429 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003430 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 -06003431 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003432 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003433 }
3434
Dave Houlton33c2d252017-06-09 17:08:32 -06003435 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3436 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3437 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003438 skip |=
3439 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3440 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3441 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3442 "layerCount other than 1.",
3443 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003444 }
3445 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003446 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003447 } else {
3448 assert(0);
3449 }
3450 return skip;
3451}
3452
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003453void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3454 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3455 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003456 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3457 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003458 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003459 auto src_image_state = GetImageState(srcImage);
3460 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003461
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003462 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003463 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003464 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3465 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003466 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003467}
3468
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003469// 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 -06003470bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3471 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003472 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003473 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003474 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003475 // Iterate over the layout maps for each referenced image
3476 for (const auto &layout_map_entry : pCB->image_layout_map) {
3477 const auto image = layout_map_entry.first;
3478 const auto *image_state = GetImageState(image);
3479 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003480 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003481 ImageSubresourcePair isr_pair;
3482 isr_pair.image = image;
3483 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003484 // Validate the initial_uses for each subresource referenced
3485 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3486 isr_pair.subresource = (*it_init).subresource;
3487 VkImageLayout initial_layout = (*it_init).layout;
3488 VkImageLayout image_layout;
3489 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3490 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3491 // TODO: Set memory invalid which is in mem_tracker currently
3492 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003493 // Need to look up the inital layout *state* to get a bit more information
3494 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3495 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3496 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3497 if (!matches) {
3498 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003499 skip |= log_msg(
3500 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3501 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003502 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003503 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003504 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003505 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3506 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003507 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003508 }
3509 }
John Zulauff660ad62019-03-23 07:16:05 -06003510 }
3511
3512 // Update all layout set operations (which will be a subset of the initial_layouts
3513 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3514 VkImageLayout layout = (*it_set).layout;
3515 isr_pair.subresource = (*it_set).subresource;
3516 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003517 }
3518 }
John Zulauff660ad62019-03-23 07:16:05 -06003519
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003520 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003521}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003522
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003523void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003524 for (const auto &layout_map_entry : pCB->image_layout_map) {
3525 const auto image = layout_map_entry.first;
3526 const auto *image_state = GetImageState(image);
3527 if (!image_state) continue; // Can't set layouts of a dead image
3528 const auto &subres_map = layout_map_entry.second;
3529 ImageSubresourcePair isr_pair;
3530 isr_pair.image = image;
3531 isr_pair.hasSubresource = true;
3532
3533 // Update all layout set operations (which will be a subset of the initial_layouts
3534 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3535 VkImageLayout layout = (*it_set).layout;
3536 isr_pair.subresource = (*it_set).subresource;
3537 SetGlobalLayout(isr_pair, layout);
3538 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003539 }
3540}
3541
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003542// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003543// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3544// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003545bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3546 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003547 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003548 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003549 const char *vuid;
3550 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3551
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003552 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3553 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003554 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3555 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3556 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003557 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003558 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 -08003559 "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
Shannon McPherson3ea65132018-12-05 10:37:39 -07003560 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3561 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3562 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3563 skip |=
3564 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3565 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003566 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003567 }
3568 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003569 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3570 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003571 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003572 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003573 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 -06003574 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003575 }
3576 }
3577
3578 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3579 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003580 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003581 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003582 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 -06003583 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003584 }
3585 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003586 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003587}
3588
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003589bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3590 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003591 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003592 const char *vuid;
3593 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003594
Jason Ekstranda1906302017-12-03 20:16:32 -08003595 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3596 VkFormat format = pCreateInfo->pAttachments[i].format;
3597 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3598 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3599 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003600 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 -06003601 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003602 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3603 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3604 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3605 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003606 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003607 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003608 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 -06003609 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003610 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3611 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3612 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3613 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003614 }
3615 }
3616 }
3617
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003618 // Track when we're observing the first use of an attachment
3619 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3620 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003621 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003622
3623 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3624 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3625 auto attach_index = subpass.pInputAttachments[j].attachment;
3626 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003627 switch (subpass.pInputAttachments[j].layout) {
3628 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3629 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3630 // These are ideal.
3631 break;
3632
3633 case VK_IMAGE_LAYOUT_GENERAL:
3634 // May not be optimal. TODO: reconsider this warning based on other constraints.
3635 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003636 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003637 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3638 break;
3639
Tobias Hectorbbb12282018-10-22 15:17:59 +01003640 case VK_IMAGE_LAYOUT_UNDEFINED:
3641 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003642 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003643 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3644 "Layout for input attachment reference %u in subpass %u is %s but must be "
3645 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003646 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003647 break;
3648
Piers Daniell9af77cd2019-10-16 13:54:12 -06003649 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3650 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3651 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3652 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003653 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003654 skip |= log_msg(
3655 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003656 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003657 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3658 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3659 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3660 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3661 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3662 skip |= log_msg(
3663 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003664 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003665 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3666 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3667 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3668 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3669 } else if ((subpass.pInputAttachments[j].aspectMask &
3670 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3671 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3672 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3673 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3674 const auto *attachment_reference_stencil_layout =
3675 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3676 if (attachment_reference_stencil_layout) {
3677 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3678 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3679 attachment_reference_stencil_layout->stencilLayout ==
3680 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3681 attachment_reference_stencil_layout->stencilLayout ==
3682 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3683 attachment_reference_stencil_layout->stencilLayout ==
3684 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3685 attachment_reference_stencil_layout->stencilLayout ==
3686 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3687 attachment_reference_stencil_layout->stencilLayout ==
3688 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3689 attachment_reference_stencil_layout->stencilLayout ==
3690 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3691 attachment_reference_stencil_layout->stencilLayout ==
3692 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3693 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3694 skip |=
3695 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003696 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003697 "In the attachment reference %u in subpass %u with pNext chain instance "
3698 "VkAttachmentReferenceStencilLayoutKHR"
3699 "the stencilLayout member but must not be "
3700 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3701 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3702 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3703 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3704 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3705 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3706 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3707 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3708 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3709 j, i);
3710 }
3711 } else {
3712 skip |=
3713 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 -08003714 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003715 "When the layout for input attachment reference %u in subpass %u is "
3716 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3717 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3718 "VkAttachmentReferenceStencilLayout instance.",
3719 j, i);
3720 }
3721 }
3722 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3723 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3724 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3725 skip |= log_msg(
3726 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003727 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003728 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3729 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3730 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3731 j, i);
3732 }
3733 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3734 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3735 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3736 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 -08003737 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003738 "When the aspectMask for input attachment reference %u in subpass %u is "
3739 "VK_IMAGE_ASPECT_STENCIL_BIT "
3740 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3741 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3742 j, i);
3743 }
3744 }
3745 break;
3746
Graeme Leese668a9862018-10-08 10:40:02 +01003747 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3748 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003749 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003750 break;
3751 } else {
3752 // Intentionally fall through to generic error message
3753 }
3754 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003755
Cort Stratton7547f772017-05-04 15:18:52 -07003756 default:
3757 // No other layouts are acceptable
3758 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 -06003759 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003760 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3761 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3762 }
3763
Cort Stratton7547f772017-05-04 15:18:52 -07003764 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003765 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3766 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003767
3768 bool used_as_depth =
3769 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3770 bool used_as_color = false;
3771 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3772 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3773 }
3774 if (!used_as_depth && !used_as_color &&
3775 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003776 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003777 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3778 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3779 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003780 }
3781 }
3782 attach_first_use[attach_index] = false;
3783 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003784
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003785 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3786 auto attach_index = subpass.pColorAttachments[j].attachment;
3787 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3788
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003789 // TODO: Need a way to validate shared presentable images here, currently just allowing
3790 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3791 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003792 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003793 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003794 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003795 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3796 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003797 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003798
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003799 case VK_IMAGE_LAYOUT_GENERAL:
3800 // May not be optimal; TODO: reconsider this warning based on other constraints?
3801 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003802 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003803 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3804 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003805
Tobias Hectorbbb12282018-10-22 15:17:59 +01003806 case VK_IMAGE_LAYOUT_UNDEFINED:
3807 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003808 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003809 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3810 "Layout for color attachment reference %u in subpass %u is %s but should be "
3811 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3812 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3813 break;
3814
Piers Daniell9af77cd2019-10-16 13:54:12 -06003815 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3816 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3817 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3818 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003819 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003820 skip |= log_msg(
3821 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003822 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003823 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3824 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3825 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3826 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3827 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3828 skip |= log_msg(
3829 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003830 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003831 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3832 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3833 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3834 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3835 } else if ((subpass.pColorAttachments[j].aspectMask &
3836 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3837 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3838 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3839 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3840 const auto *attachment_reference_stencil_layout =
3841 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3842 if (attachment_reference_stencil_layout) {
3843 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3844 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3845 attachment_reference_stencil_layout->stencilLayout ==
3846 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3847 attachment_reference_stencil_layout->stencilLayout ==
3848 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3849 attachment_reference_stencil_layout->stencilLayout ==
3850 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3851 attachment_reference_stencil_layout->stencilLayout ==
3852 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3853 attachment_reference_stencil_layout->stencilLayout ==
3854 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3855 attachment_reference_stencil_layout->stencilLayout ==
3856 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3857 attachment_reference_stencil_layout->stencilLayout ==
3858 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3859 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3860 skip |=
3861 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003862 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003863 "In the attachment reference %u in subpass %u with pNext chain instance "
3864 "VkAttachmentReferenceStencilLayoutKHR"
3865 "the stencilLayout member but must not be "
3866 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3867 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3868 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3869 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3870 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3871 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3872 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3873 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3874 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3875 j, i);
3876 }
3877 } else {
3878 skip |=
3879 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 -08003880 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003881 "When the layout for color attachment reference %u in subpass %u is "
3882 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3883 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3884 "VkAttachmentReferenceStencilLayout instance.",
3885 j, i);
3886 }
3887 }
3888 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3889 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3890 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3891 skip |= log_msg(
3892 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003893 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003894 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3895 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3896 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3897 j, i);
3898 }
3899 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3900 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3901 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3902 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 -08003903 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003904 "When the aspectMask for color attachment reference %u in subpass %u is "
3905 "VK_IMAGE_ASPECT_STENCIL_BIT "
3906 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3907 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3908 j, i);
3909 }
3910 }
3911 break;
3912
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003913 default:
3914 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 -06003915 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003916 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3917 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003918 }
3919
John Zulauf4eee2692019-02-09 16:14:25 -07003920 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3921 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3922 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003923 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003924 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 -07003925 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003926 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003927 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 }
3929
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003930 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003931 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3932 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003933 }
3934 attach_first_use[attach_index] = false;
3935 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003936
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003937 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3938 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003939 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3940 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3941 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003942 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003943
Dave Houltona9df0ce2018-02-07 10:51:23 -07003944 case VK_IMAGE_LAYOUT_GENERAL:
3945 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3946 // doing a bunch of transitions.
3947 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003948 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003949 "GENERAL layout for depth attachment may not give optimal performance.");
3950 break;
3951
Tobias Hectorbbb12282018-10-22 15:17:59 +01003952 case VK_IMAGE_LAYOUT_UNDEFINED:
3953 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003954 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003955 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3956 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3957 "layout or GENERAL.",
3958 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3959 break;
3960
Piers Daniell9af77cd2019-10-16 13:54:12 -06003961 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3962 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3963 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3964 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003965 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003966 skip |= log_msg(
3967 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003968 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003969 "Layout for depth attachment reference in subpass %u is %s but must not be "
3970 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3971 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3972 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3973 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3974 skip |= log_msg(
3975 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003976 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003977 "Layout for depth attachment reference in subpass %u is %s but must not be "
3978 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3979 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3980 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3981 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3982 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3983 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3984 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3985 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3986 const auto *attachment_reference_stencil_layout =
3987 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3988 if (attachment_reference_stencil_layout) {
3989 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3990 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3991 attachment_reference_stencil_layout->stencilLayout ==
3992 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3993 attachment_reference_stencil_layout->stencilLayout ==
3994 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3995 attachment_reference_stencil_layout->stencilLayout ==
3996 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3997 attachment_reference_stencil_layout->stencilLayout ==
3998 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3999 attachment_reference_stencil_layout->stencilLayout ==
4000 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4001 attachment_reference_stencil_layout->stencilLayout ==
4002 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4003 attachment_reference_stencil_layout->stencilLayout ==
4004 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4005 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
4006 skip |=
4007 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004008 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004009 "In the attachment reference in subpass %u with pNext chain instance "
4010 "VkAttachmentReferenceStencilLayoutKHR"
4011 "the stencilLayout member but must not be "
4012 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4013 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4014 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4015 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4016 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4017 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4018 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4019 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4020 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4021 i);
4022 }
4023 } else {
4024 skip |=
4025 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 -08004026 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004027 "When the layout for depth attachment reference in subpass %u is "
4028 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4029 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4030 "VkAttachmentReferenceStencilLayout instance.",
4031 i);
4032 }
4033 }
4034 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4035 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4036 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
4037 skip |= log_msg(
4038 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004039 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004040 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4041 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4042 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4043 i);
4044 }
4045 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4046 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4047 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4048 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 -08004049 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004050 "When the aspectMask for depth attachment reference in subpass %u is "
4051 "VK_IMAGE_ASPECT_STENCIL_BIT "
4052 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4053 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4054 i);
4055 }
4056 }
4057 break;
4058
Dave Houltona9df0ce2018-02-07 10:51:23 -07004059 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4060 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004061 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004062 break;
4063 } else {
4064 // Intentionally fall through to generic error message
4065 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004066 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004067
Dave Houltona9df0ce2018-02-07 10:51:23 -07004068 default:
4069 // No other layouts are acceptable
4070 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 -06004071 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004072 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4073 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4074 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004075 }
4076
4077 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4078 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004079 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4080 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004081 }
4082 attach_first_use[attach_index] = false;
4083 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004084 }
4085 return skip;
4086}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004087
Mark Lobodzinski96210742017-02-09 10:33:46 -07004088// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4089// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06004090bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004091 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004092 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004093 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004094 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004095 if (strict) {
4096 correct_usage = ((actual & desired) == desired);
4097 } else {
4098 correct_usage = ((actual & desired) != 0);
4099 }
4100 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004101 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004102 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06004103 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
4104 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06004105 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4106 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004107 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06004108 skip =
4109 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 -06004110 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4111 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004112 }
4113 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004114 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004115}
4116
4117// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4118// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004119bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004120 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004121 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
4122 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004123}
4124
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004125bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004126 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004127 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004128 bool skip = false;
4129 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4130 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07004131 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4132 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004133 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07004134 format_properties.linearTilingFeatures, image_state->createInfo.format,
4135 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004136 }
4137 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4138 if ((format_properties.optimalTilingFeatures & desired) != desired) {
4139 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4140 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004141 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04004142 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07004143 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004144 }
4145 }
4146 return skip;
4147}
4148
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004149bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004150 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004151 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004152 // layerCount must not be zero
4153 if (subresource_layers->layerCount == 0) {
4154 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4155 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
4156 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
4157 }
4158 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4159 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
4160 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4161 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
4162 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
4163 }
4164 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4165 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4166 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4167 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4168 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
4169 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4170 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4171 func_name, i, member);
4172 }
4173 return skip;
4174}
4175
Mark Lobodzinski96210742017-02-09 10:33:46 -07004176// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4177// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004178bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004179 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004180 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
4181 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004182}
4183
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004184bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004185 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004186 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004187
4188 const VkDeviceSize &range = pCreateInfo->range;
4189 if (range != VK_WHOLE_SIZE) {
4190 // Range must be greater than 0
4191 if (range <= 0) {
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-00928",
4194 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4195 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4196 range);
4197 }
4198 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004199 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4200 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004201 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-range-00929",
4203 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4204 ") 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 +02004205 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004206 range, format_size);
4207 }
4208 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004209 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
4210 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4211 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
4212 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4213 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4214 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4215 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004216 }
4217 // The sum of range and offset must be less than or equal to the size of buffer
4218 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
4219 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4220 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
4221 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4222 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4223 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4224 range, pCreateInfo->offset, buffer_state->createInfo.size);
4225 }
4226 }
4227 return skip;
4228}
4229
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004230bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004231 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004232 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004233 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4234 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
4235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4236 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
4237 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4238 "be supported for uniform texel buffers");
4239 }
4240 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4241 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
4242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4243 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
4244 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4245 "be supported for storage texel buffers");
4246 }
4247 return skip;
4248}
4249
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004250bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004251 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004252 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004253
Dave Houltond8ed0212018-05-16 17:18:24 -06004254 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004255
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004256 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004257 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 -06004258 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004259 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004260 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004261 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004262
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004263 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004264 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 -06004265 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004266 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004267 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004268 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004269
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004270 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004271 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 -06004272 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004273 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004274 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004275 }
Jeff Bolz87697532019-01-11 22:54:00 -06004276
4277 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4278 if (chained_devaddr_struct) {
4279 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4280 chained_devaddr_struct->deviceAddress != 0) {
4281 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4282 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4283 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4284 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4285 }
4286 }
4287
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004288 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4289 if (chained_opaqueaddr_struct) {
4290 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4291 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
4292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4293 "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4294 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4295 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
4296 }
4297 }
4298
Shannon McPherson4984e642019-12-05 13:04:34 -07004299 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004300 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004301 skip |= log_msg(
4302 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPherson4984e642019-12-05 13:04:34 -07004303 "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004304 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4305 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4306 }
4307
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004308 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004309 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4310 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4311 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004312 }
4313
Mark Lobodzinski96210742017-02-09 10:33:46 -07004314 return skip;
4315}
4316
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004317bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004318 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004319 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004320 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004321 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4322 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004323 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004324 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4325 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004326 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004327 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4328 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4329 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004330
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004331 // Buffer view offset must be less than the size of buffer
4332 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4333 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4334 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4335 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4336 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4337 pCreateInfo->offset, buffer_state->createInfo.size);
4338 }
4339
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004340 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004341 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4342 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4343 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4344 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4345 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4346 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4347 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4348 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4349 }
4350
4351 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4352 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4353 if ((elementSize % 3) == 0) {
4354 elementSize /= 3;
4355 }
4356 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4357 VkDeviceSize alignmentRequirement =
4358 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4359 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4360 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4361 }
4362 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4363 skip |= log_msg(
4364 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4365 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4366 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4367 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4368 ") must be a multiple of the lesser of "
4369 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4370 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4371 "(%" PRId32
4372 ") is VK_TRUE, the size of a texel of the requested format. "
4373 "If the size of a texel is a multiple of three bytes, then the size of a "
4374 "single component of format is used instead",
4375 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4376 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4377 }
4378 }
4379 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4380 VkDeviceSize alignmentRequirement =
4381 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4382 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4383 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4384 }
4385 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4386 skip |= log_msg(
4387 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4388 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4389 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4390 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4391 ") must be a multiple of the lesser of "
4392 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4393 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4394 "(%" PRId32
4395 ") is VK_TRUE, the size of a texel of the requested format. "
4396 "If the size of a texel is a multiple of three bytes, then the size of a "
4397 "single component of format is used instead",
4398 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4399 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4400 }
4401 }
4402 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004403
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004404 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004405
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004406 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004407 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004408 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004409}
4410
Mark Lobodzinski602de982017-02-09 11:01:33 -07004411// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004412bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004413 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004414 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004415 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4416 if (image != VK_NULL_HANDLE) {
4417 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4418 }
4419
Dave Houlton1d2022c2017-03-29 11:43:58 -06004420 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004421 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004422 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004423 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004424 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004425 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004426 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004427 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004428 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004429 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004430 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004431 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004432 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4433 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004434 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | 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 Lobodzinski602de982017-02-09 11:01:33 -07004436 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004437 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4438 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004439 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004440 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004441 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004443 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004444 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004445 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004446 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004447 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004448 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004449 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004450 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004451 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004452 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004453 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004454 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004455 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004456 } else if (FormatIsMultiplane(format)) {
4457 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4458 if (3 == FormatPlaneCount(format)) {
4459 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4460 }
4461 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004462 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004463 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4464 "set, where n = [0, 1, 2].",
4465 func_name);
4466 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004467 }
4468 return skip;
4469}
4470
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004471bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4472 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4473 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004474 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004475 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004476
4477 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004478 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004479 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 -06004480 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004481 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004482 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4483 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004484 }
Petr Kraus4d718682017-05-18 03:38:41 +02004485
Petr Krausffa94af2017-08-08 21:46:02 +02004486 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4487 if (subresourceRange.levelCount == 0) {
4488 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.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004490 } else {
4491 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004492
Petr Krausffa94af2017-08-08 21:46:02 +02004493 if (necessary_mip_count > image_mip_count) {
4494 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 -06004495 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004496 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004497 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004498 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004499 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004500 }
Petr Kraus4d718682017-05-18 03:38:41 +02004501 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004502 }
Petr Kraus4d718682017-05-18 03:38:41 +02004503
4504 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004505 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004506 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 -06004507 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004508 "%s: %s.baseArrayLayer (= %" PRIu32
4509 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4510 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004511 }
Petr Kraus4d718682017-05-18 03:38:41 +02004512
Petr Krausffa94af2017-08-08 21:46:02 +02004513 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4514 if (subresourceRange.layerCount == 0) {
4515 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 -06004516 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004517 } else {
4518 const uint64_t necessary_layer_count =
4519 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004520
Petr Krausffa94af2017-08-08 21:46:02 +02004521 if (necessary_layer_count > image_layer_count) {
4522 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 -06004523 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004524 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004525 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004526 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004527 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004528 }
Petr Kraus4d718682017-05-18 03:38:41 +02004529 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004530 }
Petr Kraus4d718682017-05-18 03:38:41 +02004531
Mark Lobodzinski602de982017-02-09 11:01:33 -07004532 return skip;
4533}
4534
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004535bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004536 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004537 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004538 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4539 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4540 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4541
4542 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4543 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4544
4545 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004546 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4547 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004548 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004549 : "VUID-VkImageViewCreateInfo-image-01482")
4550 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4551 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004552 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004553 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4554 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004555
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004556 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004557 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4558 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4559}
4560
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004561bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004562 const VkImageSubresourceRange &subresourceRange,
4563 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004564 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004565 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4566 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4567 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4568 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004569
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004570 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4571 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4572 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004573}
4574
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004575bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004576 const VkImageSubresourceRange &subresourceRange,
4577 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004578 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004579 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4580 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4581 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4582 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004583
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004584 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4585 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004586 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4587}
4588
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004589bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004590 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004591 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004592 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004593 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4594 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4595 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4596 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004597
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004598 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4599 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004600 subresourceRangeErrorCodes);
4601}
4602
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004603bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004604 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004605 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004606 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004607 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004608 skip |=
4609 ValidateImageUsageFlags(image_state,
4610 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4611 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4612 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4613 false, kVUIDUndefined, "vkCreateImageView()",
4614 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4615 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004616 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004617 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004618 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004619 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004620 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004621 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004622
4623 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4624 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004625 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4626 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004627 VkFormat view_format = pCreateInfo->format;
4628 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004629 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004630 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004631
Dave Houltonbd2e2622018-04-10 16:41:14 -06004632 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004633 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004634 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004635 image_usage = chained_ivuci_struct->usage;
4636 }
4637
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004638 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4639 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004640 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004641 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004642 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004643 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004644 std::stringstream ss;
4645 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004646 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004647 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004648 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 -07004649 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004650 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004651 }
4652 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004653 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004654 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4655 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4656 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4657 std::stringstream ss;
4658 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004659 << " is not in the same format compatibility class as "
4660 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004661 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4662 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004663 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 -07004664 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004665 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004666 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004667 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004668 }
4669 } else {
4670 // Format MUST be IDENTICAL to the format the image was created with
4671 if (image_format != view_format) {
4672 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004673 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004674 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004675 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004676 skip |=
4677 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004678 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004679 }
4680 }
4681
4682 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004683 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004684
4685 switch (image_type) {
4686 case VK_IMAGE_TYPE_1D:
4687 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004688 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 -07004689 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004690 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4691 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004692 }
4693 break;
4694 case VK_IMAGE_TYPE_2D:
4695 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4696 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4697 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004698 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 -07004699 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
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 (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004703 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 -07004704 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004705 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4706 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004707 }
4708 }
4709 break;
4710 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004711 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004712 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4713 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4714 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004715 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004716 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004717 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004718 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4719 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004720 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4721 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004722 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004723 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004724 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004725 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4726 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004727 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4728 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004729 }
4730 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004731 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 -07004732 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004733 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4734 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004735 }
4736 }
4737 } else {
4738 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004739 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 -07004740 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004741 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4742 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004743 }
4744 }
4745 break;
4746 default:
4747 break;
4748 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004749
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004750 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004751 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004752 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004753 }
4754
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004755 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004756 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4757 : format_properties.optimalTilingFeatures;
4758
4759 if (tiling_features == 0) {
4760 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 -07004761 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004762 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4763 "physical device.",
4764 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4765 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4766 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 -07004767 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004768 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4769 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4770 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4771 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4772 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 -07004773 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004774 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4775 "VK_IMAGE_USAGE_STORAGE_BIT.",
4776 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4777 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4778 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4779 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 -07004780 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004781 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4782 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4783 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4784 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4785 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4786 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 -07004787 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004788 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4789 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4790 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004791 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004792
Jeff Bolz9af91c52018-09-01 21:53:57 -05004793 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4794 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4795 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 -07004796 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004797 "vkCreateImageView() If image was created with usage containing "
4798 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4799 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4800 }
4801 if (view_format != VK_FORMAT_R8_UINT) {
4802 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 -07004803 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004804 "vkCreateImageView() If image was created with usage containing "
4805 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4806 }
4807 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004808 }
4809 return skip;
4810}
4811
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004812static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4813 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4814 const VkBufferCopy *pRegions) {
4815 bool skip = false;
4816
4817 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4818 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4819 VkDeviceSize src_min = UINT64_MAX;
4820 VkDeviceSize src_max = 0;
4821 VkDeviceSize dst_min = UINT64_MAX;
4822 VkDeviceSize dst_max = 0;
4823
4824 for (uint32_t i = 0; i < regionCount; i++) {
4825 src_min = std::min(src_min, pRegions[i].srcOffset);
4826 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4827 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4828 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4829
4830 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4831 if (pRegions[i].srcOffset >= src_buffer_size) {
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-srcOffset-00113",
4834 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4835 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4836 i, pRegions[i].srcOffset, i, pRegions[i].size);
4837 }
4838
4839 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4840 if (pRegions[i].dstOffset >= dst_buffer_size) {
4841 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4842 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4843 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4844 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4845 i, pRegions[i].dstOffset, i, pRegions[i].size);
4846 }
4847
4848 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4849 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4850 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4851 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4852 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4853 ") is greater than the source buffer size (%" PRIuLEAST64
4854 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4855 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4856 }
4857
4858 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4859 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4860 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4861 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4862 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4863 ") is greater than the destination buffer size (%" PRIuLEAST64
4864 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4865 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4866 }
4867 }
4868
4869 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4870 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4871 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4873 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4874 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4875 }
4876 }
4877
4878 return skip;
4879}
4880
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004881bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004882 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004883 const auto cb_node = GetCBState(commandBuffer);
4884 const auto src_buffer_state = GetBufferState(srcBuffer);
4885 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004886
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004887 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004888 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4889 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004890 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004891 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004892 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4893 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004894 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004895 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4896 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004897 skip |=
4898 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4899 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004900 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4901 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004902 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004903 return skip;
4904}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004905
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004906bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004907 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004908 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004909 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004910 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 -06004911 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004912 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004913 } else {
4914 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004915 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 -06004916 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004917 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004918 }
4919 }
4920 return skip;
4921}
4922
Jeff Bolz5c801d12019-10-09 10:38:45 -05004923bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4924 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004925 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004926 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004927
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004928 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004929 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004930 skip |=
4931 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004932 }
4933 return skip;
4934}
4935
Jeff Bolz5c801d12019-10-09 10:38:45 -05004936bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004937 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004938
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004939 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004940 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004941 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004942 }
4943 return skip;
4944}
4945
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004946bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004947 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004948 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004949 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004950 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004951 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004952 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004953 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004954 }
4955 return skip;
4956}
4957
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004958bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004959 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004960 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004961 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004962 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004963 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004964 skip |=
4965 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4966 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004967 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004968 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004969 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4970 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004971 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004972
4973 if (dstOffset >= buffer_state->createInfo.size) {
4974 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4975 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-dstOffset-00024",
4976 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4977 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4978 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
4979 }
4980
4981 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
4982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4983 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-size-00027",
4984 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4985 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4986 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
4987 }
4988
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004989 return skip;
4990}
4991
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004992bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4993 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004994 bool skip = false;
4995
4996 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004997 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4998 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004999 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 -06005000 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07005001 "%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 -06005002 "and 1, respectively.",
5003 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005004 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005005 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005006
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005007 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5008 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005009 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 -06005010 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005011 "%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 -06005012 "must be 0 and 1, respectively.",
5013 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005014 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005015 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005016
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005017 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5018 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005019 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 -06005020 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005021 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5022 "For 3D images these must be 0 and 1, respectively.",
5023 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005024 }
5025 }
5026
5027 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005028 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005029 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5030
Dave Houltona585d132019-01-18 13:05:42 -07005031 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005032 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 -06005033 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005034 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005035 " must be a multiple of this format's texel size (%" PRIu32 ").",
5036 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005037 }
5038
5039 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005040 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005041 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 -06005042 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005043 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5044 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005045 }
5046
5047 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5048 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005049 skip |=
5050 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005051 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005052 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5053 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005054 }
5055
5056 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5057 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
5058 skip |= log_msg(
5059 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005060 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005061 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5062 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005063 }
5064
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005065 // Calculate adjusted image extent, accounting for multiplane image factors
5066 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
5067 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
5068 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
5069 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
5070 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5071 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
5072 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5073 "zero or <= image subresource width (%d).",
5074 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
5075 adusted_image_extent.width);
5076 }
5077
5078 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
5079 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
5080 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
5081 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5082 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
5083 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5084 "zero or <= image subresource height (%d).",
5085 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
5086 adusted_image_extent.height);
5087 }
5088
5089 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
5090 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
5091 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
5092 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5093 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
5094 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5095 "zero or <= image subresource depth (%d).",
5096 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
5097 adusted_image_extent.depth);
5098 }
5099
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005100 // subresource aspectMask must have exactly 1 bit set
5101 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5102 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5103 if (aspect_mask_bits.count() != 1) {
5104 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 -06005105 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005106 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005107 }
5108
5109 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005110 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005111 skip |= log_msg(
5112 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005113 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005114 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5115 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005116 }
5117
5118 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005119 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005120 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005121
5122 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005123 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005124 skip |= log_msg(
5125 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005126 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005127 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5128 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005129 }
5130
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005131 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005132 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07005133 skip |= log_msg(
5134 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005135 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005136 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5137 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005138 }
5139
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005140 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005141 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5142 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5143 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005144 skip |=
5145 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005146 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005147 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5148 "width & height (%d, %d)..",
5149 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005150 }
5151
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005152 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005153 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005154 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005155 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 -06005156 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005157 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005158 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005159 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005160 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005161
5162 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005163 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005164 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005165 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
5166 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 -06005167 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07005168 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005169 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005170 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005171 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005172 }
5173
5174 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005175 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005176 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
5177 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 -06005178 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07005179 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005180 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005181 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005182 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005183 }
5184
5185 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005186 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005187 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
5188 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 -06005189 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005190 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005191 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005192 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005193 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005194 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005195 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005196
5197 // Checks that apply only to multi-planar format images
5198 if (FormatIsMultiplane(image_state->createInfo.format)) {
5199 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5200 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5201 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5202 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5203 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5204 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5205 "format has three planes.",
5206 function, i);
5207 }
5208
5209 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5210 if (0 == (pRegions[i].imageSubresource.aspectMask &
5211 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
5212 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5213 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5214 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5215 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5216 function, i);
5217 }
5218 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005219 }
5220
5221 return skip;
5222}
5223
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005224static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005225 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005226 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005227 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005228
5229 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005230 VkExtent3D extent = pRegions[i].imageExtent;
5231 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005232
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005233 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5234 {
Dave Houlton51653902018-06-22 17:32:13 -06005235 skip |=
5236 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5237 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5238 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005239 }
5240
5241 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5242
5243 // 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 -06005244 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005245 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005246 if (image_extent.width % block_extent.width) {
5247 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5248 }
5249 if (image_extent.height % block_extent.height) {
5250 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5251 }
5252 if (image_extent.depth % block_extent.depth) {
5253 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5254 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005255 }
5256
Dave Houltonfc1a4052017-04-27 14:32:45 -06005257 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005258 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 -06005259 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005260 }
5261 }
5262
5263 return skip;
5264}
5265
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005266static inline bool ValidateBufferBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state,
5267 const BUFFER_STATE *buff_state, uint32_t regionCount, const VkBufferImageCopy *pRegions,
5268 const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005269 bool skip = false;
5270
5271 VkDeviceSize buffer_size = buff_state->createInfo.size;
5272
5273 for (uint32_t i = 0; i < regionCount; i++) {
5274 VkExtent3D copy_extent = pRegions[i].imageExtent;
5275
5276 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5277 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005278 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5279 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005280
Tom Cooperb2550c72018-10-15 13:08:41 +01005281 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005282 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005283 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005284 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5285 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5286
5287 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5288 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5289 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005290 }
5291
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005292 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5293 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5294 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005295 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005296 } else {
5297 // Calculate buffer offset of final copied byte, + 1.
5298 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5299 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5300 max_buffer_offset *= unit_size; // convert to bytes
5301 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005302
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005303 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005304 skip |=
5305 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5306 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005307 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005308 }
5309 }
5310
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005311 return skip;
5312}
5313
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005314bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005315 VkBuffer dstBuffer, uint32_t regionCount,
5316 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005317 const auto cb_node = GetCBState(commandBuffer);
5318 const auto src_image_state = GetImageState(srcImage);
5319 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005320
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005321 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005322
5323 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005324 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005325
5326 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005327 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005328
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005329 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005330
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005331 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5332 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 -06005333 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005334 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005335 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005336 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005337 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005338 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005339 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005340 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005341
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005342 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005343 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005344 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5345 skip |=
5346 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005347
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005348 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005349 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005350 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5351 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005352 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005353 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5354 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005355 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005356 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5357 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005358 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005359 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005360 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005361 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005362 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5363 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5364 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005365 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005366 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005367 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005368 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005369 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5370 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005371 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5372 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5373 skip |=
5374 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5375 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5376 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005377 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5378 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005379 }
5380 return skip;
5381}
5382
John Zulauf1686f232019-07-09 16:27:11 -06005383void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5384 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5385 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5386
5387 auto cb_node = GetCBState(commandBuffer);
5388 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005389 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005390 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005391 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005392 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005393}
5394
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005395bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5396 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005397 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005398 const auto cb_node = GetCBState(commandBuffer);
5399 const auto src_buffer_state = GetBufferState(srcBuffer);
5400 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005401
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005402 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005403
5404 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005405 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005406
5407 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005408 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005409 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005410 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5411 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 -06005412 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005413 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005414 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005415 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005416 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005417 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005418 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005419 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005420 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005421 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005422 skip |=
5423 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5424 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005425 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005426 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5427 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005428 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005429 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5430 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005431 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005432 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5433 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005434 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005435 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005436 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005437 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005438 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5439 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5440 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005441 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005442 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005443 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005444 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005445 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5446 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005447 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5448 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5449 skip |=
5450 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5451 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5452 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005453 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5454 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005455 }
5456 return skip;
5457}
5458
John Zulauf1686f232019-07-09 16:27:11 -06005459void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5460 VkImageLayout dstImageLayout, uint32_t regionCount,
5461 const VkBufferImageCopy *pRegions) {
5462 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5463
5464 auto cb_node = GetCBState(commandBuffer);
5465 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005466 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005467 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005468 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005469 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005470}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005471
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005472bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005473 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005474 bool skip = false;
5475 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5476
Dave Houlton1d960ff2018-01-19 12:17:05 -07005477 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005478 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5479 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5480 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005481 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 -06005482 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005483 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005484 }
5485
John Zulaufa26d3c82019-08-14 16:09:08 -06005486 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005487 if (!image_entry) {
5488 return skip;
5489 }
5490
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005491 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5492 if (device_extensions.vk_ext_image_drm_format_modifier) {
5493 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5494 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5496 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5497 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5498 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5499 }
5500 } else {
5501 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5502 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5503 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5504 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5505 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005506 }
5507
Dave Houlton1d960ff2018-01-19 12:17:05 -07005508 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005509 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005510 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5511 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5512 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5513 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005514 }
5515
Dave Houlton1d960ff2018-01-19 12:17:05 -07005516 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005517 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005518 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5519 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5520 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5521 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005522 }
5523
Dave Houlton1d960ff2018-01-19 12:17:05 -07005524 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005525 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005526 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5527 if (FormatIsMultiplane(img_format)) {
5528 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5529 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5530 if (FormatPlaneCount(img_format) > 2u) {
5531 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5532 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5533 }
5534 if (sub_aspect != (sub_aspect & allowed_flags)) {
5535 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5536 HandleToUint64(image), vuid,
5537 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5538 ") must be a single-plane specifier flag.",
5539 sub_aspect);
5540 }
5541 } else if (FormatIsColor(img_format)) {
5542 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5543 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5544 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5545 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5546 "VK_IMAGE_ASPECT_COLOR.");
5547 }
5548 } else if (FormatIsDepthOrStencil(img_format)) {
5549 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5550 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005551 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005552 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5553 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5554 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5555 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005556 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 -06005557 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5558 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5559 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005560 }
5561 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005562
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005563 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005564 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005565 }
5566
Mike Weiblen672b58b2017-02-21 14:32:53 -07005567 return skip;
5568}