blob: ecdefb68f574d1c3bb53b98e1759c7db4104f372 [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)) {
438 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
439 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))) {
450 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
451 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)) {
461 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
462 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)) {
472 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
473 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)) {
488 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-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
566 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
567 // in common with the non-const version.)
568 const ImageSubresourceLayoutMap *subresource_map =
569 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
570
571 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
572 LayoutUseCheckAndMessage layout_check(subresource_map);
573 bool subres_skip = false;
574 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
575 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
576 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
577 subres_skip |=
578 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
579 kVUID_Core_DrawState_InvalidRenderpass,
580 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
581 "and the %s layout of the attachment is %s. The layouts must match, or the render "
582 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
583 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
584 string_VkImageLayout(layout_check.layout));
585 }
586 return !subres_skip; // quit checking subresources once we fail once
587 };
588
589 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
590 skip |= subres_skip;
591 }
592
593 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
594 framebuffer, render_pass, i, "initial layout");
595
596 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
597 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100598 }
599
Tobias Hectorc9057422019-07-23 12:15:52 +0100600 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
601 auto &subpass = pRenderPassInfo->pSubpasses[j];
602 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
603 auto &attachment_ref = subpass.pInputAttachments[k];
604 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
605 auto image_view = attachments[attachment_ref.attachment];
606 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100607
Tobias Hectorc9057422019-07-23 12:15:52 +0100608 if (view_state) {
609 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700610 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
611 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100612 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100613 }
614 }
615 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100616
Tobias Hectorc9057422019-07-23 12:15:52 +0100617 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
618 auto &attachment_ref = subpass.pColorAttachments[k];
619 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
620 auto image_view = attachments[attachment_ref.attachment];
621 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100622
Tobias Hectorc9057422019-07-23 12:15:52 +0100623 if (view_state) {
624 auto image = view_state->create_info.image;
625 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
626 framebuffer, render_pass, attachment_ref.attachment,
627 "color attachment layout");
628 if (subpass.pResolveAttachments) {
629 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
630 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
631 attachment_ref.attachment, "resolve attachment layout");
632 }
633 }
634 }
635 }
636
637 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
638 auto &attachment_ref = *subpass.pDepthStencilAttachment;
639 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
640 auto image_view = attachments[attachment_ref.attachment];
641 auto view_state = GetImageViewState(image_view);
642
643 if (view_state) {
644 auto image = view_state->create_info.image;
645 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
646 framebuffer, render_pass, attachment_ref.attachment,
647 "input attachment layout");
648 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100649 }
650 }
651 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700652 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600653 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700654}
655
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600656void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700657 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700658 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700659 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600660 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700661 VkImageLayout stencil_layout = kInvalidLayout;
662 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
663 if (attachment_reference_stencil_layout) {
664 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
665 }
666
667 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600668 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700669 }
670}
671
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600672void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
673 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700674 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700675
676 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700677 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700678 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700679 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700680 }
681 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700682 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683 }
684 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700685 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700686 }
687 }
688}
689
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700690// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
691// 1. Transition into initialLayout state
692// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600693void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700694 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700695 // First transition into initialLayout
696 auto const rpci = render_pass_state->createInfo.ptr();
697 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700698 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600699 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700700 VkImageLayout stencil_layout = kInvalidLayout;
701 const auto *attachment_description_stencil_layout =
702 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
703 if (attachment_description_stencil_layout) {
704 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
705 }
706
707 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600708 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700709 }
710 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700711 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700712}
713
Dave Houlton10b39482017-03-16 13:18:15 -0600714bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600715 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600716 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600717 }
718 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600719 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600720 }
721 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600722 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600723 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700724 if (0 !=
725 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
726 if (FormatPlaneCount(format) == 1) return false;
727 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600728 return true;
729}
730
Mike Weiblen62d08a32017-03-07 22:18:27 -0700731// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200732bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
733 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600734 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700735 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200736 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600737 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700738
739 switch (layout) {
740 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
741 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600742 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700743 }
744 break;
745 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
746 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600747 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 }
749 break;
750 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
751 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600752 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700753 }
754 break;
755 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
756 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600757 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700758 }
759 break;
760 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
761 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600762 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700763 }
764 break;
765 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
766 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600767 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700768 }
769 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600770 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500771 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
772 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
773 }
774 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700775 default:
776 // Other VkImageLayout values do not have VUs defined in this context.
777 break;
778 }
779
Dave Houlton8e9f6542018-05-18 12:18:22 -0600780 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600781 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 +0200782 HandleToUint64(img_barrier.image), msg_code,
783 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
784 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
785 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700786 }
787 return skip;
788}
789
790// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600791bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
792 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700793 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700794
Petr Krausad0096a2019-08-09 18:35:04 +0200795 // Scoreboard for checking for duplicate and inconsistent barriers to images
796 struct ImageBarrierScoreboardEntry {
797 uint32_t index;
798 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
799 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
800 const VkImageMemoryBarrier *barrier;
801 };
802 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
803 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
804
John Zulauf463c51e2018-05-31 13:29:20 -0600805 // Scoreboard for duplicate layout transition barriers within the list
806 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
807 ImageBarrierScoreboardImageMap layout_transitions;
808
Mike Weiblen62d08a32017-03-07 22:18:27 -0700809 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200810 const auto &img_barrier = pImageMemoryBarriers[i];
811 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700812
John Zulauf463c51e2018-05-31 13:29:20 -0600813 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
814 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
815 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200816 if (img_barrier.oldLayout != img_barrier.newLayout) {
817 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
818 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600819 if (image_it != layout_transitions.end()) {
820 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200821 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600822 if (subres_it != subres_map.end()) {
823 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200824 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
825 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
826 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600827 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700828 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
829 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200830 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600831 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
832 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200833 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
834 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
835 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600836 }
837 entry = new_entry;
838 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200839 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600840 }
841 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200842 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600843 }
844 }
845
Petr Krausad0096a2019-08-09 18:35:04 +0200846 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600847 if (image_state) {
848 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200849 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
850 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600851
852 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
853 if (image_state->layout_locked) {
854 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600855 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700856 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200857 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600858 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600859 " 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 +0200860 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
861 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600862 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600863
John Zulaufa4472282019-08-22 14:44:34 -0600864 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600865 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600866 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200867 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell9af77cd2019-10-16 13:54:12 -0600868 if (enabled_features.separate_depth_stencil_layouts_features.separateDepthStencilLayouts) {
869 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
870 skip |=
871 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
872 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03319",
873 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600874 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200875 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600876 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600877 }
878 } else {
879 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
880 if ((aspect_mask & ds_mask) != (ds_mask)) {
881 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
882 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03320",
883 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
884 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
885 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
886 string_VkFormat(image_create_info.format), aspect_mask);
887 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700888 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700889 }
John Zulauff660ad62019-03-23 07:16:05 -0600890
Petr Krausad0096a2019-08-09 18:35:04 +0200891 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
892 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600893 // TODO: Set memory invalid which is in mem_tracker currently
894 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
895 // subresource.
896 } else if (subresource_map) {
897 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600898 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200899 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600900 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600901 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200902 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600903 subres_skip =
904 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
905 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600906 "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 -0600907 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200908 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
909 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600910 string_VkImageLayout(layout_check.layout));
911 }
912 return !subres_skip;
913 };
914 subresource_map->ForRange(normalized_isr, subres_callback);
915 skip |= subres_skip;
916 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700917 }
918 }
919 return skip;
920}
921
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600922bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200923 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700924
Jeff Bolz6835fda2019-10-06 00:15:34 -0500925 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200926 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700927}
928
John Zulauf6b4aae82018-05-09 13:03:36 -0600929template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600930bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
931 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600932 using BarrierRecord = QFOTransferBarrier<Barrier>;
933 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500934 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
936 const char *barrier_name = BarrierRecord::BarrierName();
937 const char *handle_name = BarrierRecord::HandleName();
938 const char *transfer_type = nullptr;
939 for (uint32_t b = 0; b < barrier_count; b++) {
940 if (!IsTransferOp(&barriers[b])) continue;
941 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700942 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600943 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600944 const auto found = barrier_sets.release.find(barriers[b]);
945 if (found != barrier_sets.release.cend()) {
946 barrier_record = &(*found);
947 transfer_type = "releasing";
948 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600949 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600950 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600951 const auto found = barrier_sets.acquire.find(barriers[b]);
952 if (found != barrier_sets.acquire.cend()) {
953 barrier_record = &(*found);
954 transfer_type = "acquiring";
955 }
956 }
957 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700958 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
959 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
960 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
961 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
962 func_name, barrier_name, b, transfer_type, handle_name,
963 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
964 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 }
966 }
967 return skip;
968}
969
John Zulaufa4472282019-08-22 14:44:34 -0600970VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
971 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
972}
973
974const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
975 return device_state.GetImageState(barrier.image);
976}
977
978VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
979 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
980}
981
982const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
983 return device_state.GetBufferState(barrier.buffer);
984}
985
986VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
987
John Zulauf6b4aae82018-05-09 13:03:36 -0600988template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600989void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
990 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -0500991 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600992 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
993 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600994 auto &barrier = barriers[b];
995 if (IsTransferOp(&barrier)) {
996 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
997 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
998 barrier_sets.release.emplace(barrier);
999 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
1000 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1001 barrier_sets.acquire.emplace(barrier);
1002 }
1003 }
1004
1005 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1006 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1007 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1008 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1009 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1010 auto handle_state = BarrierHandleState(*this, barrier);
1011 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1012 if (!mode_concurrent) {
1013 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001014 cb_state->queue_submit_functions.emplace_back(
1015 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1016 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1017 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1018 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001019 });
1020 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001021 }
1022 }
1023}
1024
John Zulaufa4472282019-08-22 14:44:34 -06001025bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001026 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001027 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001028 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001029 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001030 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1031 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001032 return skip;
1033}
1034
John Zulaufa4472282019-08-22 14:44:34 -06001035void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1036 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1037 const VkImageMemoryBarrier *pImageMemBarriers) {
1038 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1039 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001040}
1041
1042template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001043bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001044 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001045 // Record to the scoreboard or report that we have a duplication
1046 bool skip = false;
1047 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1048 if (!inserted.second && inserted.first->second != cb_state) {
1049 // 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 -07001050 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1051 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1052 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -06001053 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -07001054 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1055 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001056 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001057 }
1058 return skip;
1059}
1060
1061template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001062bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1063 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001064 using BarrierRecord = QFOTransferBarrier<Barrier>;
1065 using TypeTag = typename BarrierRecord::Tag;
1066 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001067 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001068 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001069 const char *barrier_name = BarrierRecord::BarrierName();
1070 const char *handle_name = BarrierRecord::HandleName();
1071 // No release should have an extant duplicate (WARNING)
1072 for (const auto &release : cb_barriers.release) {
1073 // Check the global pending release barriers
1074 const auto set_it = global_release_barriers.find(release.handle);
1075 if (set_it != global_release_barriers.cend()) {
1076 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1077 const auto found = set_for_handle.find(release);
1078 if (found != set_for_handle.cend()) {
1079 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1080 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001081 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001082 " to dstQueueFamilyIndex %" PRIu32
1083 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001084 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001085 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1086 }
1087 }
1088 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1089 }
1090 // Each acquire must have a matching release (ERROR)
1091 for (const auto &acquire : cb_barriers.acquire) {
1092 const auto set_it = global_release_barriers.find(acquire.handle);
1093 bool matching_release_found = false;
1094 if (set_it != global_release_barriers.cend()) {
1095 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1096 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1097 }
1098 if (!matching_release_found) {
1099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1100 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001101 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1102 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1103 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001104 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1105 }
1106 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1107 }
1108 return skip;
1109}
1110
John Zulauf3b04ebd2019-07-18 14:08:11 -06001111bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001112 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001113 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001114 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001115 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1116 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001117 return skip;
1118}
1119
1120template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001121void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001122 using BarrierRecord = QFOTransferBarrier<Barrier>;
1123 using TypeTag = typename BarrierRecord::Tag;
1124 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001125 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001126
1127 // Add release barriers from this submit to the global map
1128 for (const auto &release : cb_barriers.release) {
1129 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1130 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1131 global_release_barriers[release.handle].insert(release);
1132 }
1133
1134 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1135 for (const auto &acquire : cb_barriers.acquire) {
1136 // NOTE: We're not using [] because we don't want to create entries for missing releases
1137 auto set_it = global_release_barriers.find(acquire.handle);
1138 if (set_it != global_release_barriers.end()) {
1139 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1140 set_for_handle.erase(acquire);
1141 if (set_for_handle.size() == 0) { // Clean up empty sets
1142 global_release_barriers.erase(set_it);
1143 }
1144 }
1145 }
1146}
1147
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001148void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001149 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1150 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001151}
1152
John Zulauf6b4aae82018-05-09 13:03:36 -06001153// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001154void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001155
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001156void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001157 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001158 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001159 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001160
Chris Forbes4de4b132017-08-21 11:27:08 -07001161 // For ownership transfers, the barrier is specified twice; as a release
1162 // operation on the yielding queue family, and as an acquire operation
1163 // on the acquiring queue family. This barrier may also include a layout
1164 // transition, which occurs 'between' the two operations. For validation
1165 // purposes it doesn't seem important which side performs the layout
1166 // transition, but it must not be performed twice. We'll arbitrarily
1167 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001168 //
1169 // However, we still need to record initial layout for the "initial layout" validation
1170 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001171
Petr Krausad0096a2019-08-09 18:35:04 +02001172 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001173 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001174 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001175 for (const auto &image : image_state->aliasing_images) {
1176 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001177 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001178 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001179 }
1180}
1181
unknown86bcb3a2019-07-11 13:05:36 -06001182void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001183 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001184 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1185 const auto &image_create_info = image_state->createInfo;
1186
1187 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1188 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1189 // for all (potential) layer sub_resources.
1190 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1191 normalized_isr.baseArrayLayer = 0;
1192 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1193 }
1194
John Zulauf2be3fe02019-12-30 09:48:02 -07001195 if (is_release_op) {
1196 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1197 } else {
1198 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1199 }
unknown86bcb3a2019-07-11 13:05:36 -06001200}
1201
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001202bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1203 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1204 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1205 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001206 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001207 assert(cb_node);
1208 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001209 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001210 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001211
John Zulauff660ad62019-03-23 07:16:05 -06001212 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1213 if (subresource_map) {
1214 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001215 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1216 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001217 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001218 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001219 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001220 subres_skip |=
1221 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1222 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001223 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001224 "%s layout %s.",
1225 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1226 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001227 }
John Zulauff660ad62019-03-23 07:16:05 -06001228 return !subres_skip;
1229 };
1230 subresource_map->ForRange(range, subresource_cb);
1231 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001232 }
John Zulauff660ad62019-03-23 07:16:05 -06001233
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001234 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1235 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1236 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001237 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1238 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001239 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001240 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001241 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001242 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001243 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001244 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001245 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001246 if (image_state->shared_presentable) {
1247 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1249 layout_invalid_msg_code,
1250 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1251 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001252 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001253 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001254 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001255 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001256 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 -07001257 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001258 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001259 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1260 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001261 }
1262 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001263 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001264}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001265bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001266 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1267 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001268 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001269 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1270 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1271}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001272
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001273void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001274 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001275 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001276 if (!renderPass) return;
1277
Tobias Hectorbbb12282018-10-22 15:17:59 +01001278 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001279 if (framebuffer_state) {
1280 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001281 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001282 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001283 VkImageLayout stencil_layout = kInvalidLayout;
1284 const auto *attachment_description_stencil_layout =
1285 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1286 if (attachment_description_stencil_layout) {
1287 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1288 }
1289
1290 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001291 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001292 }
1293 }
1294}
Dave Houltone19e20d2018-02-02 16:32:41 -07001295
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296#ifdef VK_USE_PLATFORM_ANDROID_KHR
1297// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1298// This could also move into a seperate core_validation_android.cpp file... ?
1299
1300//
1301// AHB-specific validation within non-AHB APIs
1302//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001303bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 bool skip = false;
1305
1306 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1307 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001308 if (0 != ext_fmt_android->externalFormat) {
1309 if (VK_FORMAT_UNDEFINED != create_info->format) {
1310 skip |=
1311 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1312 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001313 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001314 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1315 }
1316
1317 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1318 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1319 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001320 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001321 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1322 }
1323
1324 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1325 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1326 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001327 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001328 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1329 }
1330
1331 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1332 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1333 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001334 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001335 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1336 }
1337 }
1338
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001339 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001340 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1341 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001342 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001343 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1344 }
1345 }
1346
Dave Houltond9611312018-11-19 17:03:36 -07001347 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001348 if (VK_FORMAT_UNDEFINED == create_info->format) {
1349 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1350 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001351 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001352 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1353 }
1354 }
1355
1356 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1357 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1358 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001359 skip |=
1360 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1361 "VUID-VkImageCreateInfo-pNext-02393",
1362 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1363 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1364 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001365 }
1366
1367 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1368 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1369 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001370 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001371 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1372 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1373 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1374 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001375 }
1376
1377 return skip;
1378}
1379
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001380bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001381 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001382 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001383
1384 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001385 if (VK_FORMAT_UNDEFINED != create_info->format) {
1386 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1387 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1388 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1389 "format member is %s.",
1390 string_VkFormat(create_info->format));
1391 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001392
Dave Houltond9611312018-11-19 17:03:36 -07001393 // Chain must include a compatible ycbcr conversion
1394 bool conv_found = false;
1395 uint64_t external_format = 0;
1396 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1397 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001398 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001399 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001400 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001401 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001402 }
Dave Houltond9611312018-11-19 17:03:36 -07001403 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001404 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001405 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 -07001406 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1407 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1408 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1409 }
1410
1411 // Errors in create_info swizzles
1412 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1413 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1414 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1415 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1416 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1417 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1418 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1419 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001420 }
1421 }
Dave Houltond9611312018-11-19 17:03:36 -07001422
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001423 return skip;
1424}
1425
John Zulaufa26d3c82019-08-14 16:09:08 -06001426bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001427 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001428
John Zulaufa26d3c82019-08-14 16:09:08 -06001429 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001430 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1431 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1432 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001433 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001434 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1435 "bound to memory.");
1436 }
1437 return skip;
1438}
1439
1440#else
1441
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001442bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001443 return false;
1444}
1445
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001446bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447
John Zulaufa26d3c82019-08-14 16:09:08 -06001448bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001449
1450#endif // VK_USE_PLATFORM_ANDROID_KHR
1451
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001452bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001453 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001454 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001455
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001456 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001457 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001458 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1459 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1460 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1461 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001462 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001463 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001464 }
1465
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001466 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1467 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1468 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1469 "VUID-VkImageCreateInfo-flags-00949",
1470 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1471 "flag bit is set");
1472 }
1473
1474 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1475 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1476 "VUID-VkImageCreateInfo-imageType-00954",
1477 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1478 "height (%d) and arrayLayers (%d) must be >= 6.",
1479 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1480 }
Dave Houlton130c0212018-01-29 13:39:56 -07001481 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001482
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001483 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001484 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1485 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1486 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001487 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 +00001488 "VUID-VkImageCreateInfo-usage-00964",
1489 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1490 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001491 }
1492
1493 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001494 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 +00001495 "VUID-VkImageCreateInfo-usage-00965",
1496 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1497 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001498 }
1499
ByumjinConffx991b6062019-08-14 15:17:53 -07001500 if (device_extensions.vk_ext_fragment_density_map) {
1501 uint32_t ceiling_width =
1502 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1503 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1504 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1505 skip |=
1506 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1507 "VUID-VkImageCreateInfo-usage-02559",
1508 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1509 "ceiling of device "
1510 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1511 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1512 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1513 }
1514
1515 uint32_t ceiling_height =
1516 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1517 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1518 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1519 skip |=
1520 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1521 "VUID-VkImageCreateInfo-usage-02560",
1522 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1523 "ceiling of device "
1524 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1525 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1526 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1527 }
1528 }
1529
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001530 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001531 VkResult result = VK_SUCCESS;
1532 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1533 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1534 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1535 &format_limits);
1536 } else {
1537 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1538 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1539 image_format_info.type = pCreateInfo->imageType;
1540 image_format_info.tiling = pCreateInfo->tiling;
1541 image_format_info.usage = pCreateInfo->usage;
1542 image_format_info.flags = pCreateInfo->flags;
1543 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1544 format_limits = image_format_properties.imageFormatProperties;
1545 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001546
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001547 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001548#ifdef VK_USE_PLATFORM_ANDROID_KHR
1549 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1550#endif // VK_USE_PLATFORM_ANDROID_KHR
1551 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1552 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1553 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001554 } else {
1555 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1556 const char *format_string = string_VkFormat(pCreateInfo->format);
1557 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1558 "VUID-VkImageCreateInfo-mipLevels-02255",
1559 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1560 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1561 }
Dave Houlton130c0212018-01-29 13:39:56 -07001562
Dave Houltona585d132019-01-18 13:05:42 -07001563 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1564 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1565 (uint64_t)pCreateInfo->samples;
1566 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001567
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001568 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001569 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001570 uint64_t ig_mask = imageGranularity - 1;
1571 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001572
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001573 if (total_size > format_limits.maxResourceSize) {
1574 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1575 kVUID_Core_Image_InvalidFormatLimitsViolation,
1576 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1577 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1578 total_size, format_limits.maxResourceSize);
1579 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001580
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001581 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1582 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1583 "VUID-VkImageCreateInfo-arrayLayers-02256",
1584 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1585 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1586 }
1587
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001588 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1589 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001590 skip |= log_msg(
1591 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1592 "VUID-VkImageCreateInfo-format-02653",
1593 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1594 pCreateInfo->arrayLayers);
1595 }
1596
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001597 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1598 skip |=
1599 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1600 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001601 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001602 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001603 }
1604
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001605 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001606 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 -06001607 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001608 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1609 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001610 }
1611
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001612 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001613 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1614 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1615 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1616 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001617 skip |=
1618 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1619 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1620 "format must be block, ETC or ASTC compressed, but is %s",
1621 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001622 }
1623 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1624 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001625 skip |=
1626 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1627 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1628 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001629 }
1630 }
1631 }
1632
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001633 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001634 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1635 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1636 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001637 }
1638
unknown2c877272019-07-11 12:56:50 -06001639 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1640 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1641 skip |=
1642 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1643 "VUID-VkImageCreateInfo-format-01577",
1644 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1645 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1646 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001647 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001648}
1649
John Zulauf7eeb6f72019-06-17 11:56:36 -06001650void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1651 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1652 if (VK_SUCCESS != result) return;
1653
1654 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1655
1656 IMAGE_LAYOUT_STATE image_state;
1657 image_state.layout = pCreateInfo->initialLayout;
1658 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001659 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001660 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001661 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001662}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001663
Jeff Bolz5c801d12019-10-09 10:38:45 -05001664bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001665 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001666 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001667 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001668 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001669 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001670 }
1671 return skip;
1672}
1673
John Zulauf7eeb6f72019-06-17 11:56:36 -06001674void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1675 // Clean up validation specific data
1676 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001677
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001678 const auto &sub_entry = imageSubresourceMap.find(image);
1679 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001680 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001681 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001682 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001683 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001684 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001685
1686 // Clean up generic image state
1687 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001688}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001689
John Zulauf07288512019-07-05 11:09:50 -06001690bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001691 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001692
1693 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1694 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1695 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 -06001696 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001697 }
1698
Dave Houlton1d2022c2017-03-29 11:43:58 -06001699 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001700 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1701 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 -06001702 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001703 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001704 char const str[] = "vkCmdClearColorImage called with compressed image.";
1705 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 -06001706 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001707 }
1708
1709 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1710 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1711 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 -06001712 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001713 }
1714 return skip;
1715}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001716
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001717uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1718 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1719 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001720 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001721 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001722 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001723 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724}
1725
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001726uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1727 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1728 uint32_t array_layer_count = range->layerCount;
1729 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1730 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001731 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001732 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001733}
1734
John Zulauf07288512019-07-05 11:09:50 -06001735bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1736 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1737 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001738 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001739 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1740 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001741 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 -07001742 HandleToUint64(image_state->image), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001743 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1744 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001745 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001746
1747 } else {
1748 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1749 if (!device_extensions.vk_khr_shared_presentable_image) {
1750 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
1751 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1752 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-00005",
1753 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1754 string_VkImageLayout(dest_image_layout));
1755 }
1756 } else {
1757 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1758 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
1759 skip |= log_msg(
1760 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1761 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-01394",
1762 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1763 func_name, string_VkImageLayout(dest_image_layout));
1764 }
1765 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001766 }
1767
John Zulauff660ad62019-03-23 07:16:05 -06001768 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001769 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001770 if (subresource_map) {
1771 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001772 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001773 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001774 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001775 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001776 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001777 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1778 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1779 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1780 } else {
1781 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001782 }
John Zulauff660ad62019-03-23 07:16:05 -06001783 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1784 HandleToUint64(cb_node->commandBuffer), error_code,
1785 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1786 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1787 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001788 }
John Zulauff660ad62019-03-23 07:16:05 -06001789 return !subres_skip;
1790 };
1791 subresource_map->ForRange(normalized_isr, subres_callback);
1792 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001793 }
1794
1795 return skip;
1796}
1797
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001798bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1799 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001800 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001801 bool skip = false;
1802 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001803 const auto *cb_node = GetCBState(commandBuffer);
1804 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001805 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001806 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001807 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001808 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001809 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001810 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001811 skip |=
1812 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1813 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001814 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001815 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001816 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001817 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001818 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001819 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1820 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001821 }
1822 }
1823 return skip;
1824}
1825
John Zulaufeabb4462019-07-05 14:13:03 -06001826void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1827 const VkClearColorValue *pColor, uint32_t rangeCount,
1828 const VkImageSubresourceRange *pRanges) {
1829 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1830
1831 auto cb_node = GetCBState(commandBuffer);
1832 auto image_state = GetImageState(image);
1833 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001834 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001835 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001836 }
1837 }
1838}
1839
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001840bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1841 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001842 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001843 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001844
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001845 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001846 const auto *cb_node = GetCBState(commandBuffer);
1847 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001848 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001849 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001850 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001851 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001852 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001853 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001854 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001855 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1856 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001857 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001858 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001859 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001860 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001861 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001862 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001863 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001864 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001865 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1866 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001867 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001868 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1869 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001870 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 -06001871 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001872 }
1873 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001874 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001875 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001876 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 -06001877 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001878 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001879 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1880 char const str[] =
1881 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1882 "set.";
1883 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 -06001884 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001885 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001886 }
1887 return skip;
1888}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001889
John Zulaufeabb4462019-07-05 14:13:03 -06001890void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1891 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1892 const VkImageSubresourceRange *pRanges) {
1893 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1894 auto cb_node = GetCBState(commandBuffer);
1895 auto image_state = GetImageState(image);
1896 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001897 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001898 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001899 }
1900 }
1901}
1902
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001903// Returns true if [x, xoffset] and [y, yoffset] overlap
1904static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1905 bool result = false;
1906 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1907 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1908
1909 if (intersection_max > intersection_min) {
1910 result = true;
1911 }
1912 return result;
1913}
1914
Dave Houltonc991cc92018-03-06 11:08:51 -07001915// Returns true if source area of first copy region intersects dest area of second region
1916// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1917static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001918 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001919
Dave Houltonc991cc92018-03-06 11:08:51 -07001920 // Separate planes within a multiplane image cannot intersect
1921 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001922 return result;
1923 }
1924
Dave Houltonc991cc92018-03-06 11:08:51 -07001925 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1926 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1927 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001928 result = true;
1929 switch (type) {
1930 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001931 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001932 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001933 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001934 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001935 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001936 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001937 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001938 break;
1939 default:
1940 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1941 assert(false);
1942 }
1943 }
1944 return result;
1945}
1946
Dave Houltonfc1a4052017-04-27 14:32:45 -06001947// Returns non-zero if offset and extent exceed image extents
1948static const uint32_t x_bit = 1;
1949static const uint32_t y_bit = 2;
1950static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001951static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001952 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001953 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001954 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1955 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001956 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001957 }
1958 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1959 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001960 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001961 }
1962 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1963 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001965 }
1966 return result;
1967}
1968
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001969// Test if two VkExtent3D structs are equivalent
1970static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1971 bool result = true;
1972 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1973 (extent->depth != other_extent->depth)) {
1974 result = false;
1975 }
1976 return result;
1977}
1978
Dave Houltonee281a52017-12-08 13:51:02 -07001979// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1980// Destination image texel extents must be adjusted by block size for the dest validation checks
1981VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1982 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06001983 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1984 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001985 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001986 adjusted_extent.width /= block_size.width;
1987 adjusted_extent.height /= block_size.height;
1988 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06001989 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
1990 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07001991 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001992 adjusted_extent.width *= block_size.width;
1993 adjusted_extent.height *= block_size.height;
1994 adjusted_extent.depth *= block_size.depth;
1995 }
1996 return adjusted_extent;
1997}
1998
Dave Houlton6f9059e2017-05-02 17:15:13 -06001999// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002000static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2001 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002002
2003 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002004 if (mip >= img->createInfo.mipLevels) {
2005 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002006 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002007
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002008 // 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 -06002009 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002010
Dave Houltone48cd112019-01-03 17:01:18 -07002011 // If multi-plane, adjust per-plane extent
2012 if (FormatIsMultiplane(img->createInfo.format)) {
2013 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2014 extent.width /= divisors.width;
2015 extent.height /= divisors.height;
2016 }
2017
Jeff Bolzef40fec2018-09-01 22:04:34 -05002018 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2019 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002020 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002021 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2022 } else {
2023 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2024 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2025 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2026 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002027
Dave Houlton6f9059e2017-05-02 17:15:13 -06002028 // Image arrays have an effective z extent that isn't diminished by mip level
2029 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002030 extent.depth = img->createInfo.arrayLayers;
2031 }
2032
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 return extent;
2034}
2035
2036// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002037static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002038 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2039}
2040
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002041// Test if the extent argument has any dimensions set to 0.
2042static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2043 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2044}
2045
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002046// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002047VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002048 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2049 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002050 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002051 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002052 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002053 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002054 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 granularity.width *= block_size.width;
2056 granularity.height *= block_size.height;
2057 }
2058 }
2059 return granularity;
2060}
2061
2062// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2063static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2064 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002065 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2066 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002067 valid = false;
2068 }
2069 return valid;
2070}
2071
2072// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002073bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002074 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002075 bool skip = false;
2076 VkExtent3D offset_extent = {};
2077 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2078 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2079 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002080 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002081 // 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 -07002082 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002083 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 -04002084 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002085 "%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 "
2086 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002087 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002088 }
2089 } else {
2090 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2091 // integer multiples of the image transfer granularity.
2092 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002093 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 -04002094 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002095 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2096 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002097 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2098 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002099 }
2100 }
2101 return skip;
2102}
2103
2104// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002105bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002106 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002107 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002108 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002109 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002110 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2111 // subresource extent.
2112 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002113 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 -04002114 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002115 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2116 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2117 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2118 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002119 }
2120 } else {
2121 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2122 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2123 // subresource extent dimensions.
2124 VkExtent3D offset_extent_sum = {};
2125 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2126 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2127 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002128 bool x_ok = true;
2129 bool y_ok = true;
2130 bool z_ok = true;
2131 switch (image_type) {
2132 case VK_IMAGE_TYPE_3D:
2133 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2134 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002135 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002136 case VK_IMAGE_TYPE_2D:
2137 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2138 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002139 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002140 case VK_IMAGE_TYPE_1D:
2141 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2142 (subresource_extent->width == offset_extent_sum.width));
2143 break;
2144 default:
2145 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2146 assert(false);
2147 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002148 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002149 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 -04002150 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002151 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2152 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2153 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2154 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2155 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2156 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002157 }
2158 }
2159 return skip;
2160}
2161
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002162bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002163 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002164 bool skip = false;
2165 if (mip_level >= img->createInfo.mipLevels) {
2166 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2167 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002168 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2169 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002170 }
2171 return skip;
2172}
2173
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002174bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002175 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002176 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002177 bool skip = false;
2178 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2179 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2181 HandleToUint64(cb_node->commandBuffer), vuid,
2182 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002183 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002184 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2185 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002186 }
2187 return skip;
2188}
2189
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002190// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002191bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002192 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002193 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002194 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002195 VkExtent3D granularity = GetScaledItg(cb_node, img);
2196 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002197 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002198 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002199 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002200 return skip;
2201}
2202
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002203// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002204bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002205 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002206 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002207 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002208 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002209 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2210 skip |=
2211 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002212 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002213 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002214 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2215 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002217 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002218 granularity = GetScaledItg(cb_node, dst_img);
2219 skip |=
2220 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002221 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002222 const VkExtent3D dest_effective_extent =
2223 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002224 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002225 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002226 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002227 return skip;
2228}
2229
Dave Houlton6f9059e2017-05-02 17:15:13 -06002230// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002231bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002232 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233 bool skip = false;
2234
2235 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002236 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002237
2238 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002239 const VkExtent3D src_copy_extent = region.extent;
2240 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002241 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2242
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 bool slice_override = false;
2244 uint32_t depth_slices = 0;
2245
2246 // Special case for copying between a 1D/2D array and a 3D image
2247 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2248 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002249 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002250 slice_override = (depth_slices != 1);
2251 } 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 -07002252 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002253 slice_override = (depth_slices != 1);
2254 }
2255
2256 // Do all checks on source image
2257 //
2258 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002259 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2260 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 -06002261 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002262 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002263 "be 0 and 1, respectively.",
2264 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002265 }
2266 }
2267
Dave Houlton533be9f2018-03-26 17:08:30 -06002268 // VUID-VkImageCopy-srcImage-01785
2269 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2270 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 -06002271 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002272 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002273 "these must be 0 and 1, respectively.",
2274 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276
Dave Houlton533be9f2018-03-26 17:08:30 -06002277 // VUID-VkImageCopy-srcImage-01787
2278 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2279 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 -06002280 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002281 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2282 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002283 }
2284
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002285 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002286 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002287 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 skip |=
2289 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002290 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002291 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002292 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2293 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 }
2295 }
2296 } else { // Pre maint 1
2297 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002298 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002299 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 -06002300 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002301 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2302 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002303 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2304 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 }
2306 }
2307 }
2308
Dave Houltonc991cc92018-03-06 11:08:51 -07002309 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002310 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002311 if (FormatIsCompressed(src_state->createInfo.format) ||
2312 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002313 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002314 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002315 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2316 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2317 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002318 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002319 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 -07002320 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002321 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002322 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002323 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002324 }
2325
Dave Houlton94a00372017-12-14 15:08:47 -07002326 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002327 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2328 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002329 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 skip |=
2331 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002332 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002333 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002334 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002335 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 }
2337
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002338 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002339 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2340 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002341 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002342 skip |=
2343 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002344 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002345 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002346 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002347 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002348 }
2349
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002350 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002351 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2352 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002353 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002354 skip |=
2355 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002356 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002357 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002358 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002359 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002360 }
2361 } // Compressed
2362
2363 // Do all checks on dest image
2364 //
2365 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002366 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002367 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 -06002368 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002369 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002370 "these must be 0 and 1, respectively.",
2371 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002372 }
2373 }
2374
Dave Houlton533be9f2018-03-26 17:08:30 -06002375 // VUID-VkImageCopy-dstImage-01786
2376 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2377 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 -06002378 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002379 "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 -06002380 "and 1, respectively.",
2381 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002382 }
2383
2384 // VUID-VkImageCopy-dstImage-01788
2385 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2386 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 -06002387 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002388 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2389 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002390 }
2391
2392 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002393 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394 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 -06002395 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002396 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002397 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2398 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 }
2400 }
2401 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002402 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002404 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002405 skip |=
2406 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002407 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002408 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002409 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2410 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 }
2412 }
2413 } else { // Pre maint 1
2414 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002415 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002416 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 -06002417 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002418 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2419 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002420 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2421 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 }
2423 }
2424 }
2425
Dave Houltonc991cc92018-03-06 11:08:51 -07002426 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2427 if (FormatIsCompressed(dst_state->createInfo.format) ||
2428 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002429 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002430
2431 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002432 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2433 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2434 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002435 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002436 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 -07002437 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002438 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002439 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002440 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002441 }
2442
Dave Houlton94a00372017-12-14 15:08:47 -07002443 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002444 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2445 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002446 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002447 skip |=
2448 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002449 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002450 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002451 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002452 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002453 }
2454
Dave Houltonee281a52017-12-08 13:51:02 -07002455 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2456 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2457 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002458 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002459 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 -07002460 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002461 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2462 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002463 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002464 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002465 }
2466
Dave Houltonee281a52017-12-08 13:51:02 -07002467 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2468 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2469 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002470 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002471 skip |=
2472 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002473 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002474 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002475 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002476 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002477 }
2478 } // Compressed
2479 }
2480 return skip;
2481}
2482
Dave Houltonc991cc92018-03-06 11:08:51 -07002483// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002484bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002485 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002486 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002487
2488 // Neither image is multiplane
2489 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2490 // If neither image is multi-plane the aspectMask member of src and dst must match
2491 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2492 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002493 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002494 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2495 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 -06002496 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002497 }
2498 } else {
2499 // Source image multiplane checks
2500 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2501 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2502 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2503 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002504 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002505 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 -06002506 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002507 }
2508 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2509 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2510 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002511 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002512 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 -06002513 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002514 }
2515 // Single-plane to multi-plane
2516 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2517 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2518 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002519 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002520 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-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002522 }
2523
2524 // Dest image multiplane checks
2525 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2526 aspect = region.dstSubresource.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(): Dest 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-dstImage-01554", "%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(): Dest 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-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002539 }
2540 // Multi-plane to single-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(): Dest 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-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002547 }
2548 }
2549
2550 return skip;
2551}
2552
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002553bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2554 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002555 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002556 const auto *cb_node = GetCBState(commandBuffer);
2557 const auto *src_image_state = GetImageState(srcImage);
2558 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002559 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002560
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002561 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002562
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002563 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2564
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002565 for (uint32_t i = 0; i < regionCount; i++) {
2566 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002567
2568 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2569 VkExtent3D src_copy_extent = region.extent;
2570 VkExtent3D dst_copy_extent =
2571 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2572
Dave Houlton6f9059e2017-05-02 17:15:13 -06002573 bool slice_override = false;
2574 uint32_t depth_slices = 0;
2575
2576 // Special case for copying between a 1D/2D array and a 3D image
2577 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2578 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2579 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002580 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002581 slice_override = (depth_slices != 1);
2582 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2583 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002584 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002585 slice_override = (depth_slices != 1);
2586 }
2587
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002588 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2589 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2590 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002591 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002592 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002593 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002594 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002595 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2596 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002597 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002598 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2599 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002600
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002601 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002602 // No chance of mismatch if we're overriding depth slice count
2603 if (!slice_override) {
2604 // The number of depth slices in srcSubresource and dstSubresource must match
2605 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2606 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002607 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2608 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002609 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002610 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2611 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002612 if (src_slices != dst_slices) {
2613 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002614 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002615 << "] do not match";
2616 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 -06002617 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002618 }
2619 }
2620 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002621 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002622 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002623 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002624 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002625 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002626 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 -06002627 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002628 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002629 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002630
Dave Houltonc991cc92018-03-06 11:08:51 -07002631 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002632 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002633 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002634 }
2635
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002636 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002637 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2638 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002639 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002640 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 -06002641 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002642 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002643 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002644
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002645 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002646 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002647 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002648 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002649 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2650 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 -06002651 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002652 }
2653
2654 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002655 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002656 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002657 ss << "vkCmdCopyImage(): pRegion[" << i
2658 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002659 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 -06002660 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002661 }
2662
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002663 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2664 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2665 // 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 -07002666 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2667 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002668 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002669 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002670 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2671 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2672 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002673 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 -06002674 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002675 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002676
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002677 // 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 -07002678 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2679 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002680 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002681 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002682 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2683 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2684 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002685 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 -06002686 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002687 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002688 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002689
Dave Houltonfc1a4052017-04-27 14:32:45 -06002690 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002691 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2692 if (slice_override) src_copy_extent.depth = depth_slices;
2693 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002694 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002695 skip |=
2696 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2697 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2698 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2699 "width [%1d].",
2700 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002701 }
2702
2703 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002704 skip |=
2705 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2706 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2707 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2708 "height [%1d].",
2709 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002710 }
2711 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002712 skip |=
2713 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2714 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2715 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2716 "depth [%1d].",
2717 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002718 }
2719
Dave Houltonee281a52017-12-08 13:51:02 -07002720 // Adjust dest extent if necessary
2721 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2722 if (slice_override) dst_copy_extent.depth = depth_slices;
2723
2724 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002725 if (extent_check & x_bit) {
2726 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 -06002727 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002728 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002729 "width [%1d].",
2730 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002731 }
2732 if (extent_check & y_bit) {
2733 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 -06002734 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002735 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002736 "height [%1d].",
2737 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002738 }
2739 if (extent_check & z_bit) {
2740 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 -06002741 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002742 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002743 "depth [%1d].",
2744 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002745 }
2746
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002747 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2748 // must not overlap in memory
2749 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002750 for (uint32_t j = 0; j < regionCount; j++) {
2751 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002752 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002753 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002754 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002755 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 -06002756 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002757 }
2758 }
2759 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002760 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002761
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002762 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2763 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2764 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002765 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002766 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2767 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002768 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 -06002769 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002770 }
2771 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002772 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002773 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2774 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 -06002775 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002776 }
2777 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002778
Dave Houlton33c22b72017-02-28 13:16:02 -07002779 // Source and dest image sample counts must match
2780 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2781 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2782 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 -06002783 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002784 }
2785
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002786 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2787 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002788 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002789 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2790 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2791 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2792 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002793 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002794 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2795 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2796 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2797 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002798 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002799 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002800 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002801 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2802 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002803 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002804 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2805 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2806 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2807 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2808 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2809 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002810 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002811 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002812 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2813 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002814 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002815 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2816 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002817 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2818 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002819 }
2820
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002821 return skip;
2822}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002823
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002824void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2825 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2826 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002827 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2828 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002829 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002830 auto src_image_state = GetImageState(srcImage);
2831 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002832
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002833 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002834 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002835 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2836 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002837 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002838}
2839
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002840// Returns true if sub_rect is entirely contained within rect
2841static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2842 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2843 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2844 return false;
2845 return true;
2846}
2847
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002848bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002849 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2850 const VkRect2D &render_area, uint32_t rect_count,
2851 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002852 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002853 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2854 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002855 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002856 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002857
2858 for (uint32_t j = 0; j < rect_count; j++) {
2859 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002860 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 -07002861 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2862 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2863 "the current render pass instance.",
2864 j);
2865 }
2866
2867 if (image_view_state) {
2868 // The layers specified by a given element of pRects must be contained within every attachment that
2869 // pAttachments refers to
2870 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2871 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2872 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002873 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2874 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2875 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2876 "of pAttachment[%d].",
2877 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002878 }
2879 }
2880 }
2881 return skip;
2882}
2883
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002884bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2885 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002886 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002887 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002888 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002889 if (!cb_node) return skip;
2890
2891 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2892 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2893 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002894 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002895
2896 // Validate that attachment is in reference list of active subpass
2897 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002898 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002899 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002900 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002901 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002902 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002903
John Zulauf3a548ef2019-02-01 16:14:07 -07002904 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2905 auto clear_desc = &pAttachments[attachment_index];
2906 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002907
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002908 if (0 == clear_desc->aspectMask) {
2909 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 -06002910 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002911 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2912 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 -06002913 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002914 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002915 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2916 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2917 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2918 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002919 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2920 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2921 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2922 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2923 attachment_index, clear_desc->colorAttachment,
2924 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2925 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2926 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002927
John Zulauff2582972019-02-09 14:53:30 -07002928 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2929 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002930 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2932 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002933 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002934 " subpass %u. colorAttachmentCount=%u",
2935 attachment_index, clear_desc->colorAttachment,
2936 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2937 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002938 }
John Zulauff2582972019-02-09 14:53:30 -07002939 fb_attachment = color_attachment;
2940
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002941 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2942 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2943 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002944 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002945 skip |=
2946 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2947 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002948 }
2949 } else { // Must be depth and/or stencil
2950 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2951 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002952 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002953 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 -07002954 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2955 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002956 }
2957 if (!subpass_desc->pDepthStencilAttachment ||
2958 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2959 skip |= log_msg(
2960 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002961 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002962 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002963 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002964 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002965 }
2966 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002967 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002968 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2969 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002970 }
2971 }
2972 }
2973 return skip;
2974}
2975
2976void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2977 const VkClearAttachment *pAttachments, uint32_t rectCount,
2978 const VkClearRect *pRects) {
2979 auto *cb_node = GetCBState(commandBuffer);
2980 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2981 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2982 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2983 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2984 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2985 const auto clear_desc = &pAttachments[attachment_index];
2986 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2987 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2988 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2989 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2990 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2991 subpass_desc->pDepthStencilAttachment) {
2992 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2993 }
2994 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002995 if (!clear_rect_copy) {
2996 // We need a copy of the clear rectangles that will persist until the last lambda executes
2997 // but we want to create it as lazily as possible
2998 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002999 }
John Zulauf441558b2019-08-12 11:47:39 -06003000 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3001 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003002 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003003 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003004 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003005 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003006 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3007 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003008 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3009 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003010 return skip;
3011 };
3012 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003013 }
3014 }
3015 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003016}
3017
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003018bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3019 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003020 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003021 const auto *cb_node = GetCBState(commandBuffer);
3022 const auto *src_image_state = GetImageState(srcImage);
3023 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003024
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003025 bool skip = false;
3026 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003027 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3028 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003029 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003030 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003031 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3032 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003033 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3034 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003035
Cort Stratton7df30962018-05-17 19:45:57 -07003036 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003037 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003038 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003039 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3040 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3041 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003042 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003043 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3044 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003045 // For each region, the number of layers in the image subresource should not be zero
3046 // For each region, src and dest image aspect must be color only
3047 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003048 skip |=
3049 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3050 skip |=
3051 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003052 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003053 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3054 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003055 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003056 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3057 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003058 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3059 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3060 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3061 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3062 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003063 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3064 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003065 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003066 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3067 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003068
3069 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003070 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3071 skip |= log_msg(
3072 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003073 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003074 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003075 }
Cort Stratton7df30962018-05-17 19:45:57 -07003076 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003077 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3078 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3079 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003080 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003081 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 -06003082 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003083 }
3084 }
3085
3086 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3087 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003088 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 -06003089 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003090 }
3091 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3092 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003093 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003094 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003095 }
3096 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3097 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3098 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 -06003099 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003100 }
3101 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3102 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3103 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003104 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003105 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003106 } else {
3107 assert(0);
3108 }
3109 return skip;
3110}
3111
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003112bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3113 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003114 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003115 const auto *cb_node = GetCBState(commandBuffer);
3116 const auto *src_image_state = GetImageState(srcImage);
3117 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003118
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003119 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003120 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003121 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003122 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003123 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003124 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003125 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003126 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003127 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003128 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3129 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003130 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003131 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3132 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003133 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003134 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3135 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003136 skip |=
3137 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003138 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3139 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003140 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003141 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003142 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003143 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003144
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003145 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003146
Dave Houlton33c2d252017-06-09 17:08:32 -06003147 VkFormat src_format = src_image_state->createInfo.format;
3148 VkFormat dst_format = dst_image_state->createInfo.format;
3149 VkImageType src_type = src_image_state->createInfo.imageType;
3150 VkImageType dst_type = dst_image_state->createInfo.imageType;
3151
Cort Stratton186b1a22018-05-01 20:18:06 -04003152 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003153 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003154 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3155 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003156 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003157 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3158 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3159 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003160 }
3161
3162 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3163 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 -06003164 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003165 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003166 }
3167
Dave Houlton33c2d252017-06-09 17:08:32 -06003168 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3169 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3170 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 -06003171 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003172 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003173 }
3174
3175 // Validate consistency for unsigned formats
3176 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3177 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003178 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003179 << "the other one must also have unsigned integer format. "
3180 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3181 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 -06003182 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003183 }
3184
3185 // Validate consistency for signed formats
3186 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3187 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003188 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003189 << "the other one must also have signed integer format. "
3190 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3191 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 -06003192 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003193 }
3194
3195 // Validate filter for Depth/Stencil formats
3196 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3197 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003199 << "then filter must be VK_FILTER_NEAREST.";
3200 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 -06003201 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003202 }
3203
3204 // Validate aspect bits and formats for depth/stencil images
3205 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3206 if (src_format != dst_format) {
3207 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003208 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003209 << "stencil, the other one must have exactly the same format. "
3210 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3211 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003212 skip |=
3213 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3214 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003216 } // Depth or Stencil
3217
3218 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003219 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003220 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003221 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3222 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3223 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003224 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003225 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3226 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003227 for (uint32_t i = 0; i < regionCount; i++) {
3228 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003229 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003230 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003231 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3232 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003233 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003234 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3235 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003236 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3237 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3238 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003239 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003240 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003241 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003242 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003243 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3244 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003245 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003246 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3247 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003248 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003249 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3250 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003251 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003252 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003253 skip |=
3254 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3255 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003256 }
Dave Houlton48989f32017-05-26 15:01:46 -06003257 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3258 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003259 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003260 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003261 skip |=
3262 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3263 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003264 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003265
3266 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003267 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003268 skip |= log_msg(
3269 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3270 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3271 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003272 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003273
Dave Houlton48989f32017-05-26 15:01:46 -06003274 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003275 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 -06003276 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003278 }
Dave Houlton48989f32017-05-26 15:01:46 -06003279
Dave Houlton33c2d252017-06-09 17:08:32 -06003280 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3281 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 -06003282 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003283 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003284 "image format %s.",
3285 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003286 }
3287
3288 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3289 skip |= log_msg(
3290 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003291 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003292 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3293 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003294 }
3295
Dave Houlton48989f32017-05-26 15:01:46 -06003296 // Validate source image offsets
3297 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003298 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003299 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003300 skip |=
3301 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3302 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3303 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3304 "of (%1d, %1d). These must be (0, 1).",
3305 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003306 }
3307 }
3308
Dave Houlton33c2d252017-06-09 17:08:32 -06003309 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003310 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3311 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 -06003312 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003313 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003314 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3315 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003316 }
3317 }
3318
Dave Houlton33c2d252017-06-09 17:08:32 -06003319 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003320 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3321 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003322 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003323 skip |= log_msg(
3324 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3325 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3326 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3327 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003328 }
3329 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3330 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003331 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003332 skip |= log_msg(
3333 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003334 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003335 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003336 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003337 }
3338 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3339 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003340 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003341 skip |= log_msg(
3342 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3343 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3344 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3345 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003346 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003347 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003348 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 -06003349 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003350 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003351 }
Dave Houlton48989f32017-05-26 15:01:46 -06003352
3353 // Validate dest image offsets
3354 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003355 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003356 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003357 skip |=
3358 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3359 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3360 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3361 "(%1d, %1d). These must be (0, 1).",
3362 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003363 }
3364 }
3365
Dave Houlton33c2d252017-06-09 17:08:32 -06003366 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003367 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3368 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 -06003369 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003370 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003371 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3372 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003373 }
3374 }
3375
Dave Houlton33c2d252017-06-09 17:08:32 -06003376 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003377 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3378 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003379 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003380 skip |= log_msg(
3381 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3382 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3383 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3384 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003385 }
3386 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3387 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003388 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003389 skip |= log_msg(
3390 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003391 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003392 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003393 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003394 }
3395 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3396 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003397 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003398 skip |= log_msg(
3399 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3400 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3401 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3402 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003403 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003404 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003405 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 -06003406 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003407 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003408 }
3409
Dave Houlton33c2d252017-06-09 17:08:32 -06003410 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3411 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3412 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003413 skip |=
3414 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3415 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3416 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3417 "layerCount other than 1.",
3418 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003419 }
3420 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003421 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003422 } else {
3423 assert(0);
3424 }
3425 return skip;
3426}
3427
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003428void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3429 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3430 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003431 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3432 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003433 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003434 auto src_image_state = GetImageState(srcImage);
3435 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003436
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003437 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003438 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003439 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3440 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003441 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003442}
3443
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003444// 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 -06003445bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3446 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003447 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003448 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003449 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003450 // Iterate over the layout maps for each referenced image
3451 for (const auto &layout_map_entry : pCB->image_layout_map) {
3452 const auto image = layout_map_entry.first;
3453 const auto *image_state = GetImageState(image);
3454 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003455 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003456 ImageSubresourcePair isr_pair;
3457 isr_pair.image = image;
3458 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003459 // Validate the initial_uses for each subresource referenced
3460 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3461 isr_pair.subresource = (*it_init).subresource;
3462 VkImageLayout initial_layout = (*it_init).layout;
3463 VkImageLayout image_layout;
3464 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3465 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3466 // TODO: Set memory invalid which is in mem_tracker currently
3467 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003468 // Need to look up the inital layout *state* to get a bit more information
3469 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3470 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3471 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3472 if (!matches) {
3473 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003474 skip |= log_msg(
3475 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3476 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003477 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003478 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003479 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003480 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3481 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003482 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003483 }
3484 }
John Zulauff660ad62019-03-23 07:16:05 -06003485 }
3486
3487 // Update all layout set operations (which will be a subset of the initial_layouts
3488 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3489 VkImageLayout layout = (*it_set).layout;
3490 isr_pair.subresource = (*it_set).subresource;
3491 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003492 }
3493 }
John Zulauff660ad62019-03-23 07:16:05 -06003494
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003495 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003496}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003497
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003498void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003499 for (const auto &layout_map_entry : pCB->image_layout_map) {
3500 const auto image = layout_map_entry.first;
3501 const auto *image_state = GetImageState(image);
3502 if (!image_state) continue; // Can't set layouts of a dead image
3503 const auto &subres_map = layout_map_entry.second;
3504 ImageSubresourcePair isr_pair;
3505 isr_pair.image = image;
3506 isr_pair.hasSubresource = true;
3507
3508 // Update all layout set operations (which will be a subset of the initial_layouts
3509 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3510 VkImageLayout layout = (*it_set).layout;
3511 isr_pair.subresource = (*it_set).subresource;
3512 SetGlobalLayout(isr_pair, layout);
3513 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003514 }
3515}
3516
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003517// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003518// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3519// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003520bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3521 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003522 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003523 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003524 const char *vuid;
3525 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3526
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003527 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3528 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003529 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3530 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3531 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003532 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003533 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3534 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3535 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3536 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3537 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3538 skip |=
3539 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3540 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003541 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003542 }
3543 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003544 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3545 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003546 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003547 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003548 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 -06003549 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003550 }
3551 }
3552
3553 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3554 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003555 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003556 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003557 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 -06003558 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003559 }
3560 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003561 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003562}
3563
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003564bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
John Zulauf9d2b6382019-07-25 15:21:36 -06003565 const VkRenderPassCreateInfo2KHR *pCreateInfo) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003566 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003567 const char *vuid;
3568 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3569 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003570
Jason Ekstranda1906302017-12-03 20:16:32 -08003571 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3572 VkFormat format = pCreateInfo->pAttachments[i].format;
3573 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3574 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3575 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003576 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 -06003577 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003578 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3579 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3580 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3581 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003582 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003583 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003584 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 -06003585 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003586 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3587 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3588 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3589 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003590 }
3591 }
3592 }
3593
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003594 // Track when we're observing the first use of an attachment
3595 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3596 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003597 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003598
3599 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3600 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3601 auto attach_index = subpass.pInputAttachments[j].attachment;
3602 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003603 switch (subpass.pInputAttachments[j].layout) {
3604 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3605 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3606 // These are ideal.
3607 break;
3608
3609 case VK_IMAGE_LAYOUT_GENERAL:
3610 // May not be optimal. TODO: reconsider this warning based on other constraints.
3611 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003612 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003613 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3614 break;
3615
Tobias Hectorbbb12282018-10-22 15:17:59 +01003616 case VK_IMAGE_LAYOUT_UNDEFINED:
3617 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3618 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3619 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3620 "Layout for input attachment reference %u in subpass %u is %s but must be "
3621 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003622 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003623 break;
3624
Piers Daniell9af77cd2019-10-16 13:54:12 -06003625 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3626 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3627 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3628 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3629 if (!enabled_features.separate_depth_stencil_layouts_features.separateDepthStencilLayouts) {
3630 skip |= log_msg(
3631 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3632 "VUID-VkAttachmentReference2KHR-separateDepthStencilLayouts-03313",
3633 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3634 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3635 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3636 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3637 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3638 skip |= log_msg(
3639 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3640 "VUID-VkAttachmentReference2KHR-attachment-03314",
3641 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3642 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3643 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3644 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3645 } else if ((subpass.pInputAttachments[j].aspectMask &
3646 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3647 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3648 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3649 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3650 const auto *attachment_reference_stencil_layout =
3651 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3652 if (attachment_reference_stencil_layout) {
3653 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3654 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3655 attachment_reference_stencil_layout->stencilLayout ==
3656 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3657 attachment_reference_stencil_layout->stencilLayout ==
3658 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3659 attachment_reference_stencil_layout->stencilLayout ==
3660 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3661 attachment_reference_stencil_layout->stencilLayout ==
3662 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3663 attachment_reference_stencil_layout->stencilLayout ==
3664 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3665 attachment_reference_stencil_layout->stencilLayout ==
3666 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3667 attachment_reference_stencil_layout->stencilLayout ==
3668 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3669 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3670 skip |=
3671 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
3672 0, "VUID-VkAttachmentReferenceStencilLayoutKHR-stencilLayout-03318",
3673 "In the attachment reference %u in subpass %u with pNext chain instance "
3674 "VkAttachmentReferenceStencilLayoutKHR"
3675 "the stencilLayout member but must not be "
3676 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3677 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3678 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3679 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3680 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3681 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3682 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3683 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3684 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3685 j, i);
3686 }
3687 } else {
3688 skip |=
3689 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3690 "VUID-VkAttachmentReference2KHR-attachment-03315",
3691 "When the layout for input attachment reference %u in subpass %u is "
3692 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3693 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3694 "VkAttachmentReferenceStencilLayout instance.",
3695 j, i);
3696 }
3697 }
3698 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3699 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3700 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3701 skip |= log_msg(
3702 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3703 "VUID-VkAttachmentReference2KHR-attachment-03315",
3704 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3705 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3706 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3707 j, i);
3708 }
3709 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3710 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3711 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3712 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3713 "VUID-VkAttachmentReference2KHR-attachment-03317",
3714 "When the aspectMask for input attachment reference %u in subpass %u is "
3715 "VK_IMAGE_ASPECT_STENCIL_BIT "
3716 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3717 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3718 j, i);
3719 }
3720 }
3721 break;
3722
Graeme Leese668a9862018-10-08 10:40:02 +01003723 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3724 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003725 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003726 break;
3727 } else {
3728 // Intentionally fall through to generic error message
3729 }
3730 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003731
Cort Stratton7547f772017-05-04 15:18:52 -07003732 default:
3733 // No other layouts are acceptable
3734 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 -06003735 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003736 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3737 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3738 }
3739
Cort Stratton7547f772017-05-04 15:18:52 -07003740 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003741 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3742 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003743
3744 bool used_as_depth =
3745 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3746 bool used_as_color = false;
3747 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3748 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3749 }
3750 if (!used_as_depth && !used_as_color &&
3751 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003752 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3753 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3754 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3755 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003756 }
3757 }
3758 attach_first_use[attach_index] = false;
3759 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003760
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003761 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3762 auto attach_index = subpass.pColorAttachments[j].attachment;
3763 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3764
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003765 // TODO: Need a way to validate shared presentable images here, currently just allowing
3766 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3767 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003768 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003769 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003770 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003771 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3772 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003773 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003774
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003775 case VK_IMAGE_LAYOUT_GENERAL:
3776 // May not be optimal; TODO: reconsider this warning based on other constraints?
3777 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003778 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003779 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3780 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003781
Tobias Hectorbbb12282018-10-22 15:17:59 +01003782 case VK_IMAGE_LAYOUT_UNDEFINED:
3783 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3784 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3786 "Layout for color attachment reference %u in subpass %u is %s but should be "
3787 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3788 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3789 break;
3790
Piers Daniell9af77cd2019-10-16 13:54:12 -06003791 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3792 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3793 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3794 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3795 if (!enabled_features.separate_depth_stencil_layouts_features.separateDepthStencilLayouts) {
3796 skip |= log_msg(
3797 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3798 "VUID-VkAttachmentReference2KHR-separateDepthStencilLayouts-03313",
3799 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3800 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3801 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3802 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3803 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3804 skip |= log_msg(
3805 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3806 "VUID-VkAttachmentReference2KHR-attachment-03314",
3807 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3808 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3809 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3810 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3811 } else if ((subpass.pColorAttachments[j].aspectMask &
3812 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3813 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3814 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3815 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3816 const auto *attachment_reference_stencil_layout =
3817 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3818 if (attachment_reference_stencil_layout) {
3819 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3820 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3821 attachment_reference_stencil_layout->stencilLayout ==
3822 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3823 attachment_reference_stencil_layout->stencilLayout ==
3824 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3825 attachment_reference_stencil_layout->stencilLayout ==
3826 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3827 attachment_reference_stencil_layout->stencilLayout ==
3828 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3829 attachment_reference_stencil_layout->stencilLayout ==
3830 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3831 attachment_reference_stencil_layout->stencilLayout ==
3832 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3833 attachment_reference_stencil_layout->stencilLayout ==
3834 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3835 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3836 skip |=
3837 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
3838 0, "VUID-VkAttachmentReferenceStencilLayoutKHR-stencilLayout-03318",
3839 "In the attachment reference %u in subpass %u with pNext chain instance "
3840 "VkAttachmentReferenceStencilLayoutKHR"
3841 "the stencilLayout member but must not be "
3842 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3843 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3844 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3845 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3846 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3847 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3848 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3849 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3850 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3851 j, i);
3852 }
3853 } else {
3854 skip |=
3855 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3856 "VUID-VkAttachmentReference2KHR-attachment-03315",
3857 "When the layout for color attachment reference %u in subpass %u is "
3858 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3859 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3860 "VkAttachmentReferenceStencilLayout instance.",
3861 j, i);
3862 }
3863 }
3864 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3865 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3866 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3867 skip |= log_msg(
3868 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3869 "VUID-VkAttachmentReference2KHR-attachment-03315",
3870 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3871 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3872 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3873 j, i);
3874 }
3875 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3876 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3877 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3878 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3879 "VUID-VkAttachmentReference2KHR-attachment-03317",
3880 "When the aspectMask for color attachment reference %u in subpass %u is "
3881 "VK_IMAGE_ASPECT_STENCIL_BIT "
3882 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3883 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3884 j, i);
3885 }
3886 }
3887 break;
3888
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003889 default:
3890 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 -06003891 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003892 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3893 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003894 }
3895
John Zulauf4eee2692019-02-09 16:14:25 -07003896 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3897 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3898 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003899 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3900 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 -07003901 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003902 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003903 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003904 }
3905
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003906 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003907 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3908 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003909 }
3910 attach_first_use[attach_index] = false;
3911 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003912
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003913 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3914 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003915 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3916 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3917 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003918 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003919
Dave Houltona9df0ce2018-02-07 10:51:23 -07003920 case VK_IMAGE_LAYOUT_GENERAL:
3921 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3922 // doing a bunch of transitions.
3923 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003924 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003925 "GENERAL layout for depth attachment may not give optimal performance.");
3926 break;
3927
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 case VK_IMAGE_LAYOUT_UNDEFINED:
3929 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3930 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3932 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3933 "layout or GENERAL.",
3934 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3935 break;
3936
Piers Daniell9af77cd2019-10-16 13:54:12 -06003937 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3938 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3939 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3940 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
3941 if (!enabled_features.separate_depth_stencil_layouts_features.separateDepthStencilLayouts) {
3942 skip |= log_msg(
3943 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3944 "VUID-VkAttachmentReference2KHR-separateDepthStencilLayouts-03313",
3945 "Layout for depth attachment reference in subpass %u is %s but must not be "
3946 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3947 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3948 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3949 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3950 skip |= log_msg(
3951 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3952 "VUID-VkAttachmentReference2KHR-attachment-03314",
3953 "Layout for depth attachment reference in subpass %u is %s but must not be "
3954 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3955 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3956 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3957 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3958 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3959 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3960 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3961 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3962 const auto *attachment_reference_stencil_layout =
3963 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3964 if (attachment_reference_stencil_layout) {
3965 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3966 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3967 attachment_reference_stencil_layout->stencilLayout ==
3968 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3969 attachment_reference_stencil_layout->stencilLayout ==
3970 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3971 attachment_reference_stencil_layout->stencilLayout ==
3972 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3973 attachment_reference_stencil_layout->stencilLayout ==
3974 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3975 attachment_reference_stencil_layout->stencilLayout ==
3976 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3977 attachment_reference_stencil_layout->stencilLayout ==
3978 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3979 attachment_reference_stencil_layout->stencilLayout ==
3980 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3981 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3982 skip |=
3983 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
3984 0, "VUID-VkAttachmentReferenceStencilLayoutKHR-stencilLayout-03318",
3985 "In the attachment reference in subpass %u with pNext chain instance "
3986 "VkAttachmentReferenceStencilLayoutKHR"
3987 "the stencilLayout member but must not be "
3988 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3989 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3990 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3991 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3992 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3993 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3994 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3995 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3996 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3997 i);
3998 }
3999 } else {
4000 skip |=
4001 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4002 "VUID-VkAttachmentReference2KHR-attachment-03315",
4003 "When the layout for depth attachment reference in subpass %u is "
4004 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4005 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4006 "VkAttachmentReferenceStencilLayout instance.",
4007 i);
4008 }
4009 }
4010 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4011 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4012 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
4013 skip |= log_msg(
4014 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4015 "VUID-VkAttachmentReference2KHR-attachment-03315",
4016 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4017 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4018 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4019 i);
4020 }
4021 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4022 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4023 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4024 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4025 "VUID-VkAttachmentReference2KHR-attachment-03317",
4026 "When the aspectMask for depth attachment reference in subpass %u is "
4027 "VK_IMAGE_ASPECT_STENCIL_BIT "
4028 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4029 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4030 i);
4031 }
4032 }
4033 break;
4034
Dave Houltona9df0ce2018-02-07 10:51:23 -07004035 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4036 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004037 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004038 break;
4039 } else {
4040 // Intentionally fall through to generic error message
4041 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004042 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004043
Dave Houltona9df0ce2018-02-07 10:51:23 -07004044 default:
4045 // No other layouts are acceptable
4046 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 -06004047 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004048 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4049 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4050 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004051 }
4052
4053 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4054 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004055 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4056 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004057 }
4058 attach_first_use[attach_index] = false;
4059 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004060 }
4061 return skip;
4062}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004063
Mark Lobodzinski96210742017-02-09 10:33:46 -07004064// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4065// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06004066bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004067 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004068 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004069 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004070 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004071 if (strict) {
4072 correct_usage = ((actual & desired) == desired);
4073 } else {
4074 correct_usage = ((actual & desired) != 0);
4075 }
4076 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004077 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004078 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06004079 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
4080 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06004081 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4082 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004083 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06004084 skip =
4085 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 -06004086 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4087 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004088 }
4089 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004090 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004091}
4092
4093// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4094// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004095bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004096 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004097 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
4098 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004099}
4100
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004101bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004102 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004103 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004104 bool skip = false;
4105 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4106 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07004107 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4108 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004109 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07004110 format_properties.linearTilingFeatures, image_state->createInfo.format,
4111 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004112 }
4113 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4114 if ((format_properties.optimalTilingFeatures & desired) != desired) {
4115 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4116 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004117 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04004118 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07004119 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004120 }
4121 }
4122 return skip;
4123}
4124
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004125bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004126 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004127 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004128 // layerCount must not be zero
4129 if (subresource_layers->layerCount == 0) {
4130 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4131 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
4132 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
4133 }
4134 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4135 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
4136 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
4138 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
4139 }
4140 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4141 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4142 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4143 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4144 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
4145 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4146 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4147 func_name, i, member);
4148 }
4149 return skip;
4150}
4151
Mark Lobodzinski96210742017-02-09 10:33:46 -07004152// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4153// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004154bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004155 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004156 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
4157 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004158}
4159
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004160bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004161 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004162 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004163
4164 const VkDeviceSize &range = pCreateInfo->range;
4165 if (range != VK_WHOLE_SIZE) {
4166 // Range must be greater than 0
4167 if (range <= 0) {
4168 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4169 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
4170 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4171 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4172 range);
4173 }
4174 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004175 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4176 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004177 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4178 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
4179 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4180 ") 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 +02004181 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004182 range, format_size);
4183 }
4184 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004185 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
4186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4187 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
4188 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4189 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4190 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4191 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004192 }
4193 // The sum of range and offset must be less than or equal to the size of buffer
4194 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
4195 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4196 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
4197 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4198 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4199 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4200 range, pCreateInfo->offset, buffer_state->createInfo.size);
4201 }
4202 }
4203 return skip;
4204}
4205
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004206bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004207 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004208 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004209 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4210 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
4211 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4212 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
4213 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4214 "be supported for uniform texel buffers");
4215 }
4216 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4217 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
4218 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4219 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
4220 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4221 "be supported for storage texel buffers");
4222 }
4223 return skip;
4224}
4225
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004226bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004227 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004228 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004229
Dave Houltond8ed0212018-05-16 17:18:24 -06004230 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004231
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004232 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004233 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 -06004234 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004235 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004236 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004237 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004238
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004239 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004240 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 -06004241 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004242 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004243 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004244 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004245
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004246 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004247 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 -06004248 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004249 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004250 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004251 }
Jeff Bolz87697532019-01-11 22:54:00 -06004252
4253 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4254 if (chained_devaddr_struct) {
4255 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4256 chained_devaddr_struct->deviceAddress != 0) {
4257 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4258 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4259 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4260 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4261 }
4262 }
4263
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004264 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4265 if (chained_opaqueaddr_struct) {
4266 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4267 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
4268 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4269 "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4270 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4271 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
4272 }
4273 }
4274
Shannon McPherson4984e642019-12-05 13:04:34 -07004275 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004276 !enabled_features.buffer_device_address.bufferDeviceAddressCaptureReplay &&
4277 !enabled_features.buffer_device_address_ext.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004278 skip |= log_msg(
4279 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPherson4984e642019-12-05 13:04:34 -07004280 "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004281 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4282 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4283 }
4284
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004285 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004286 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4287 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4288 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004289 }
4290
Mark Lobodzinski96210742017-02-09 10:33:46 -07004291 return skip;
4292}
4293
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004294bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004295 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004296 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004297 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004298 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4299 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004300 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004301 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4302 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004303 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004304 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4305 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4306 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004307
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004308 // Buffer view offset must be less than the size of buffer
4309 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4310 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4311 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4312 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4313 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4314 pCreateInfo->offset, buffer_state->createInfo.size);
4315 }
4316
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004317 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004318 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4319 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4320 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4321 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4322 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4323 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4324 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4325 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4326 }
4327
4328 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4329 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4330 if ((elementSize % 3) == 0) {
4331 elementSize /= 3;
4332 }
4333 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4334 VkDeviceSize alignmentRequirement =
4335 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4336 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4337 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4338 }
4339 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4340 skip |= log_msg(
4341 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4342 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4343 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4344 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4345 ") must be a multiple of the lesser of "
4346 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4347 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4348 "(%" PRId32
4349 ") is VK_TRUE, the size of a texel of the requested format. "
4350 "If the size of a texel is a multiple of three bytes, then the size of a "
4351 "single component of format is used instead",
4352 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4353 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4354 }
4355 }
4356 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4357 VkDeviceSize alignmentRequirement =
4358 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4359 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
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-02751",
4366 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4367 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4368 ") must be a multiple of the lesser of "
4369 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4370 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
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.uniformTexelBufferOffsetAlignmentBytes,
4376 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4377 }
4378 }
4379 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004380
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004381 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004382
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004383 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004384 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004385 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004386}
4387
Mark Lobodzinski602de982017-02-09 11:01:33 -07004388// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004389bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004390 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004391 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004392 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4393 if (image != VK_NULL_HANDLE) {
4394 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4395 }
4396
Dave Houlton1d2022c2017-03-29 11:43:58 -06004397 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004398 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004399 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004400 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004401 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004402 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004403 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004404 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004405 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004406 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004408 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004409 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4410 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004411 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004412 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004413 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004414 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4415 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004416 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004417 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004418 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004419 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004420 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004421 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
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: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004424 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004425 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004426 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004427 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004428 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004429 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004430 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004431 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004432 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004433 } else if (FormatIsMultiplane(format)) {
4434 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4435 if (3 == FormatPlaneCount(format)) {
4436 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4437 }
4438 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004439 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004440 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4441 "set, where n = [0, 1, 2].",
4442 func_name);
4443 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004444 }
4445 return skip;
4446}
4447
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004448bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4449 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4450 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004451 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004452 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004453
4454 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004455 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004456 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 -06004457 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004458 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004459 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4460 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004461 }
Petr Kraus4d718682017-05-18 03:38:41 +02004462
Petr Krausffa94af2017-08-08 21:46:02 +02004463 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4464 if (subresourceRange.levelCount == 0) {
4465 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 -06004466 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004467 } else {
4468 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004469
Petr Krausffa94af2017-08-08 21:46:02 +02004470 if (necessary_mip_count > image_mip_count) {
4471 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 -06004472 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004473 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004474 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004475 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004476 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004477 }
Petr Kraus4d718682017-05-18 03:38:41 +02004478 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004479 }
Petr Kraus4d718682017-05-18 03:38:41 +02004480
4481 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004482 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004483 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 -06004484 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004485 "%s: %s.baseArrayLayer (= %" PRIu32
4486 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4487 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004488 }
Petr Kraus4d718682017-05-18 03:38:41 +02004489
Petr Krausffa94af2017-08-08 21:46:02 +02004490 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4491 if (subresourceRange.layerCount == 0) {
4492 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 -06004493 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004494 } else {
4495 const uint64_t necessary_layer_count =
4496 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004497
Petr Krausffa94af2017-08-08 21:46:02 +02004498 if (necessary_layer_count > image_layer_count) {
4499 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 -06004500 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004501 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004502 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004503 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004504 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004505 }
Petr Kraus4d718682017-05-18 03:38:41 +02004506 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004507 }
Petr Kraus4d718682017-05-18 03:38:41 +02004508
Mark Lobodzinski602de982017-02-09 11:01:33 -07004509 return skip;
4510}
4511
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004512bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004513 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004514 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004515 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4516 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4517 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4518
4519 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4520 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4521
4522 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004523 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4524 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004525 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004526 : "VUID-VkImageViewCreateInfo-image-01482")
4527 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4528 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004529 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004530 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4531 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004532
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004533 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004534 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4535 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4536}
4537
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004538bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004539 const VkImageSubresourceRange &subresourceRange,
4540 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004541 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004542 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4543 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4544 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4545 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004546
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004547 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4548 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4549 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004550}
4551
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004552bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004553 const VkImageSubresourceRange &subresourceRange,
4554 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004555 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004556 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4557 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4558 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4559 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004560
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004561 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4562 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004563 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4564}
4565
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004566bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004567 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004568 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004569 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004570 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4571 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4572 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4573 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004574
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004575 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4576 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004577 subresourceRangeErrorCodes);
4578}
4579
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004580bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004581 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004582 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004583 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004584 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004585 skip |=
4586 ValidateImageUsageFlags(image_state,
4587 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4588 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4589 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4590 false, kVUIDUndefined, "vkCreateImageView()",
4591 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4592 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004593 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004594 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004595 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004596 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004597 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004598 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004599
4600 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4601 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004602 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4603 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004604 VkFormat view_format = pCreateInfo->format;
4605 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004606 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004607 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004608
Dave Houltonbd2e2622018-04-10 16:41:14 -06004609 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004610 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004611 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004612 image_usage = chained_ivuci_struct->usage;
4613 }
4614
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004615 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4616 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004617 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004618 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004619 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004620 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004621 std::stringstream ss;
4622 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004623 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004624 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004625 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 -07004626 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004627 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004628 }
4629 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004630 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004631 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4632 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4633 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4634 std::stringstream ss;
4635 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004636 << " is not in the same format compatibility class as "
4637 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004638 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4639 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004640 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 -07004641 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004642 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004643 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004644 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004645 }
4646 } else {
4647 // Format MUST be IDENTICAL to the format the image was created with
4648 if (image_format != view_format) {
4649 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004650 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004651 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004652 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004653 skip |=
4654 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004655 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004656 }
4657 }
4658
4659 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004660 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004661
4662 switch (image_type) {
4663 case VK_IMAGE_TYPE_1D:
4664 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004665 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 -07004666 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004667 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4668 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004669 }
4670 break;
4671 case VK_IMAGE_TYPE_2D:
4672 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4673 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4674 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004675 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 -07004676 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004677 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4678 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004679 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004681 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004682 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4683 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004684 }
4685 }
4686 break;
4687 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004688 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004689 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4690 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4691 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004692 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004693 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004694 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004695 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4696 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004697 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4698 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004699 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004700 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004701 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004702 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4703 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004704 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4705 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004706 }
4707 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004708 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 -07004709 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004710 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4711 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004712 }
4713 }
4714 } else {
4715 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004716 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 -07004717 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
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 }
4721 }
4722 break;
4723 default:
4724 break;
4725 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004726
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004727 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004728 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004729 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004730 }
4731
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004732 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004733 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4734 : format_properties.optimalTilingFeatures;
4735
4736 if (tiling_features == 0) {
4737 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 -07004738 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004739 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4740 "physical device.",
4741 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4742 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4743 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 -07004744 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004745 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4746 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4747 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4748 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4749 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 -07004750 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004751 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4752 "VK_IMAGE_USAGE_STORAGE_BIT.",
4753 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4754 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4755 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4756 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 -07004757 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004758 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4759 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4760 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4761 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4762 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4763 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 -07004764 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004765 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4766 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4767 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004768 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004769
Jeff Bolz9af91c52018-09-01 21:53:57 -05004770 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4771 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
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-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004774 "vkCreateImageView() If image was created with usage containing "
4775 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4776 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4777 }
4778 if (view_format != VK_FORMAT_R8_UINT) {
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-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004781 "vkCreateImageView() If image was created with usage containing "
4782 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4783 }
4784 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004785 }
4786 return skip;
4787}
4788
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004789static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4790 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4791 const VkBufferCopy *pRegions) {
4792 bool skip = false;
4793
4794 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4795 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4796 VkDeviceSize src_min = UINT64_MAX;
4797 VkDeviceSize src_max = 0;
4798 VkDeviceSize dst_min = UINT64_MAX;
4799 VkDeviceSize dst_max = 0;
4800
4801 for (uint32_t i = 0; i < regionCount; i++) {
4802 src_min = std::min(src_min, pRegions[i].srcOffset);
4803 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4804 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4805 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4806
4807 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4808 if (pRegions[i].srcOffset >= src_buffer_size) {
4809 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4810 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4811 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4812 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4813 i, pRegions[i].srcOffset, i, pRegions[i].size);
4814 }
4815
4816 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4817 if (pRegions[i].dstOffset >= dst_buffer_size) {
4818 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4819 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4820 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4821 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4822 i, pRegions[i].dstOffset, i, pRegions[i].size);
4823 }
4824
4825 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4826 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4827 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4828 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4829 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4830 ") is greater than the source buffer size (%" PRIuLEAST64
4831 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4832 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4833 }
4834
4835 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4836 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4838 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4839 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4840 ") is greater than the destination buffer size (%" PRIuLEAST64
4841 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4842 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4843 }
4844 }
4845
4846 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4847 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4848 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4849 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4850 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4851 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4852 }
4853 }
4854
4855 return skip;
4856}
4857
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004858bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004859 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004860 const auto cb_node = GetCBState(commandBuffer);
4861 const auto src_buffer_state = GetBufferState(srcBuffer);
4862 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004863
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004864 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004865 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4866 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004867 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004868 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004869 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4870 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004871 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004872 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4873 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004874 skip |=
4875 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4876 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004877 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4878 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004879 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004880 return skip;
4881}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004882
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004883bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004884 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004885 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004886 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004887 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 -06004888 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004889 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004890 } else {
4891 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004892 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004893 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004894 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004895 }
4896 }
4897 return skip;
4898}
4899
Jeff Bolz5c801d12019-10-09 10:38:45 -05004900bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4901 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004902 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004903 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004904
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004905 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004906 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004907 skip |=
4908 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004909 }
4910 return skip;
4911}
4912
Jeff Bolz5c801d12019-10-09 10:38:45 -05004913bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004914 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004915
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004916 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004917 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004918 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004919 }
4920 return skip;
4921}
4922
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004923bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004924 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004925 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004926 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004927 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004928 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004929 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004930 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004931 }
4932 return skip;
4933}
4934
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004935bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004936 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004937 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004938 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004939 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004940 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004941 skip |=
4942 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4943 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004944 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004945 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004946 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4947 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004948 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004949
4950 if (dstOffset >= buffer_state->createInfo.size) {
4951 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4952 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-dstOffset-00024",
4953 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4954 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4955 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
4956 }
4957
4958 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
4959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4960 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-size-00027",
4961 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4962 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4963 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
4964 }
4965
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004966 return skip;
4967}
4968
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004969bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4970 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004971 bool skip = false;
4972
4973 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004974 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4975 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004976 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 -06004977 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004978 "%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 -06004979 "and 1, respectively.",
4980 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004981 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004982 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004983
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004984 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4985 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004986 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 -06004987 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004988 "%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 -06004989 "must be 0 and 1, respectively.",
4990 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004991 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004992 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004993
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004994 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4995 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004996 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 -06004997 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004998 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4999 "For 3D images these must be 0 and 1, respectively.",
5000 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005001 }
5002 }
5003
5004 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005005 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005006 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5007
Dave Houltona585d132019-01-18 13:05:42 -07005008 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -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-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005011 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005012 " must be a multiple of this format's texel size (%" PRIu32 ").",
5013 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005014 }
5015
5016 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005017 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005018 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 -06005019 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005020 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5021 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005022 }
5023
5024 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5025 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005026 skip |=
5027 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005028 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005029 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5030 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005031 }
5032
5033 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5034 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
5035 skip |= log_msg(
5036 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005037 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005038 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5039 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005040 }
5041
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005042 // Calculate adjusted image extent, accounting for multiplane image factors
5043 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
5044 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
5045 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
5046 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
5047 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5048 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
5049 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5050 "zero or <= image subresource width (%d).",
5051 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
5052 adusted_image_extent.width);
5053 }
5054
5055 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
5056 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
5057 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
5058 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5059 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
5060 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5061 "zero or <= image subresource height (%d).",
5062 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
5063 adusted_image_extent.height);
5064 }
5065
5066 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
5067 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
5068 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
5069 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5070 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
5071 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5072 "zero or <= image subresource depth (%d).",
5073 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
5074 adusted_image_extent.depth);
5075 }
5076
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005077 // subresource aspectMask must have exactly 1 bit set
5078 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5079 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5080 if (aspect_mask_bits.count() != 1) {
5081 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 -06005082 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005083 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005084 }
5085
5086 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005087 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005088 skip |= log_msg(
5089 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005090 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005091 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5092 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005093 }
5094
5095 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005096 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005097 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005098
5099 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005100 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005101 skip |= log_msg(
5102 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005103 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005104 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5105 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005106 }
5107
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005108 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005109 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07005110 skip |= log_msg(
5111 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005112 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005113 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5114 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005115 }
5116
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005117 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005118 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5119 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5120 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005121 skip |=
5122 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005123 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005124 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5125 "width & height (%d, %d)..",
5126 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005127 }
5128
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005129 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005130 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005131 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005132 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 -06005133 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005134 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005135 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005136 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005137 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005138
5139 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005140 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005141 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005142 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
5143 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 -06005144 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07005145 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005146 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005147 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005148 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005149 }
5150
5151 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005152 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005153 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
5154 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 -06005155 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07005156 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005157 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005158 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005159 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005160 }
5161
5162 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005163 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005164 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
5165 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 -06005166 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005167 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005168 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005169 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005170 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005171 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005172 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005173
5174 // Checks that apply only to multi-planar format images
5175 if (FormatIsMultiplane(image_state->createInfo.format)) {
5176 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5177 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5178 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5180 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5181 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5182 "format has three planes.",
5183 function, i);
5184 }
5185
5186 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5187 if (0 == (pRegions[i].imageSubresource.aspectMask &
5188 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
5189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5190 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5191 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5192 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5193 function, i);
5194 }
5195 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005196 }
5197
5198 return skip;
5199}
5200
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005201static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005202 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005203 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005204 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005205
5206 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005207 VkExtent3D extent = pRegions[i].imageExtent;
5208 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005209
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005210 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5211 {
Dave Houlton51653902018-06-22 17:32:13 -06005212 skip |=
5213 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5214 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5215 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005216 }
5217
5218 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5219
5220 // 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 -06005221 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005222 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005223 if (image_extent.width % block_extent.width) {
5224 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5225 }
5226 if (image_extent.height % block_extent.height) {
5227 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5228 }
5229 if (image_extent.depth % block_extent.depth) {
5230 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5231 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005232 }
5233
Dave Houltonfc1a4052017-04-27 14:32:45 -06005234 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005235 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 -06005236 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005237 }
5238 }
5239
5240 return skip;
5241}
5242
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005243static inline bool ValidateBufferBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state,
5244 const BUFFER_STATE *buff_state, uint32_t regionCount, const VkBufferImageCopy *pRegions,
5245 const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005246 bool skip = false;
5247
5248 VkDeviceSize buffer_size = buff_state->createInfo.size;
5249
5250 for (uint32_t i = 0; i < regionCount; i++) {
5251 VkExtent3D copy_extent = pRegions[i].imageExtent;
5252
5253 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5254 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005255 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5256 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005257
Tom Cooperb2550c72018-10-15 13:08:41 +01005258 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005259 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005260 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005261 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5262 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5263
5264 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5265 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5266 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005267 }
5268
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005269 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5270 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5271 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005272 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005273 } else {
5274 // Calculate buffer offset of final copied byte, + 1.
5275 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5276 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5277 max_buffer_offset *= unit_size; // convert to bytes
5278 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005279
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005280 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005281 skip |=
5282 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5283 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005284 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005285 }
5286 }
5287
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005288 return skip;
5289}
5290
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005291bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005292 VkBuffer dstBuffer, uint32_t regionCount,
5293 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005294 const auto cb_node = GetCBState(commandBuffer);
5295 const auto src_image_state = GetImageState(srcImage);
5296 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005297
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005298 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005299
5300 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005301 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005302
5303 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005304 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005305
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005306 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005307
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005308 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5309 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 -06005310 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005311 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005312 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005313 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005314 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005315 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005316 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005317 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005318
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005319 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005320 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005321 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5322 skip |=
5323 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005324
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005325 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005326 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005327 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5328 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005329 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005330 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5331 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005332 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005333 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5334 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005335 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005336 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005337 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005338 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005339 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5340 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5341 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005342 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005343 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005344 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005345 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005346 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5347 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005348 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5349 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5350 skip |=
5351 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5352 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5353 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005354 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5355 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005356 }
5357 return skip;
5358}
5359
John Zulauf1686f232019-07-09 16:27:11 -06005360void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5361 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5362 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5363
5364 auto cb_node = GetCBState(commandBuffer);
5365 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005366 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005367 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005368 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005369 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005370}
5371
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005372bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5373 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005374 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005375 const auto cb_node = GetCBState(commandBuffer);
5376 const auto src_buffer_state = GetBufferState(srcBuffer);
5377 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005378
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005379 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005380
5381 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005382 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005383
5384 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005385 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005386 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005387 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5388 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 -06005389 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005390 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005391 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005392 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005393 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005394 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005395 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005396 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005397 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005398 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005399 skip |=
5400 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5401 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005402 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005403 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5404 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005405 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005406 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5407 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005408 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005409 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5410 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005411 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005412 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005413 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005414 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005415 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5416 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5417 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005418 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005419 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005420 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005421 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005422 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5423 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005424 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5425 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5426 skip |=
5427 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5428 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5429 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005430 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5431 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005432 }
5433 return skip;
5434}
5435
John Zulauf1686f232019-07-09 16:27:11 -06005436void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5437 VkImageLayout dstImageLayout, uint32_t regionCount,
5438 const VkBufferImageCopy *pRegions) {
5439 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5440
5441 auto cb_node = GetCBState(commandBuffer);
5442 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005443 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005444 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005445 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005446 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005447}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005448
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005449bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005450 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005451 bool skip = false;
5452 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5453
Dave Houlton1d960ff2018-01-19 12:17:05 -07005454 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005455 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5456 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5457 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005458 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 -06005459 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005460 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005461 }
5462
John Zulaufa26d3c82019-08-14 16:09:08 -06005463 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005464 if (!image_entry) {
5465 return skip;
5466 }
5467
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005468 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5469 if (device_extensions.vk_ext_image_drm_format_modifier) {
5470 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5471 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5473 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5474 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5475 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5476 }
5477 } else {
5478 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5479 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5480 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5481 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5482 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005483 }
5484
Dave Houlton1d960ff2018-01-19 12:17:05 -07005485 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005486 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005487 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5488 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5489 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5490 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005491 }
5492
Dave Houlton1d960ff2018-01-19 12:17:05 -07005493 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005494 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5496 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5497 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5498 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005499 }
5500
Dave Houlton1d960ff2018-01-19 12:17:05 -07005501 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005502 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005503 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5504 if (FormatIsMultiplane(img_format)) {
5505 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5506 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5507 if (FormatPlaneCount(img_format) > 2u) {
5508 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5509 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5510 }
5511 if (sub_aspect != (sub_aspect & allowed_flags)) {
5512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5513 HandleToUint64(image), vuid,
5514 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5515 ") must be a single-plane specifier flag.",
5516 sub_aspect);
5517 }
5518 } else if (FormatIsColor(img_format)) {
5519 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5520 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5521 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5522 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5523 "VK_IMAGE_ASPECT_COLOR.");
5524 }
5525 } else if (FormatIsDepthOrStencil(img_format)) {
5526 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5527 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005528 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005529 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5530 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5531 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5532 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005533 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 -06005534 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5535 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5536 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005537 }
5538 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005539
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005540 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005541 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005542 }
5543
Mike Weiblen672b58b2017-02-21 14:32:53 -07005544 return skip;
5545}