blob: e3362a5669beeac27363903711fa88974a171075 [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
John Zulaufb58415b2019-12-09 15:02:32 -070055static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
56 const VkImageSubresourceRange &range);
57static VkImageSubresourceRange MakeImageFullRange(const VkImageCreateInfo &create_info) {
58 const auto format = create_info.format;
59 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
60 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
61 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
62 } else {
63 init_range.aspectMask =
64 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
65 }
66 return NormalizeSubresourceRange(create_info, init_range);
67}
68
John Zulauff660ad62019-03-23 07:16:05 -060069IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
70 : image(img),
71 createInfo(*pCreateInfo),
72 valid(false),
73 acquired(false),
74 shared_presentable(false),
75 layout_locked(false),
76 get_sparse_reqs_called(false),
77 sparse_metadata_required(false),
78 sparse_metadata_bound(false),
79 imported_ahb(false),
80 has_ahb_format(false),
81 ahb_format(0),
John Zulaufb58415b2019-12-09 15:02:32 -070082 full_range{MakeImageFullRange(createInfo)},
unknown09edc722019-06-21 15:49:38 -060083 create_from_swapchain(VK_NULL_HANDLE),
84 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060085 bind_swapchain_imageIndex(0),
John Zulaufb58415b2019-12-09 15:02:32 -070086 range_encoder(full_range),
unknown08c57af2019-06-21 16:33:35 -060087 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060088 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
89 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
90 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
91 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
92 }
93 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
94 }
95
96 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
97 sparse = true;
98 }
Locked8af3732019-05-10 09:47:56 -060099
sfricke-samsunge2441192019-11-06 14:07:57 -0800100 auto *externalMemoryInfo = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(pCreateInfo->pNext);
101 if (externalMemoryInfo) {
102 external_memory_handle = externalMemoryInfo->handleTypes;
103 }
104
Locked8af3732019-05-10 09:47:56 -0600105#ifdef VK_USE_PLATFORM_ANDROID_KHR
106 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
107 if (external_format) {
108 external_format_android = external_format->externalFormat;
109 } else {
110 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
111 external_format_android = 0;
112 }
113#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600114}
115
unknown2c877272019-07-11 12:56:50 -0600116bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
117 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
118 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
119 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
120 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
121 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
122 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
123 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
124}
125
Jeff Bolz82f854d2019-09-17 14:56:47 -0500126// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
127bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
128 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
129 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
130 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
131 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
132 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
133 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
134
135 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
136 createInfo.extent.height <= other_createInfo.extent.height &&
137 createInfo.extent.depth <= other_createInfo.extent.depth &&
138 createInfo.arrayLayers <= other_createInfo.arrayLayers;
139 return is_compatible;
140}
141
unknown2c877272019-07-11 12:56:50 -0600142bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
143 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
144 if ((create_from_swapchain == VK_NULL_HANDLE) && (binding.mem == other_image_state->binding.mem) &&
145 (binding.mem != VK_NULL_HANDLE) && (binding.offset == other_image_state->binding.offset) &&
146 IsCreateInfoEqual(other_image_state->createInfo)) {
147 return true;
148 }
unknowne1661522019-07-11 13:04:18 -0600149 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
150 return true;
151 }
unknown2c877272019-07-11 12:56:50 -0600152 return false;
153}
154
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500155IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const std::shared_ptr<IMAGE_STATE> &im, VkImageView iv, const VkImageViewCreateInfo *ci)
156 : image_view(iv),
157 create_info(*ci),
John Zulaufb58415b2019-12-09 15:02:32 -0700158 normalized_subresource_range(NormalizeSubresourceRange(*im, ci->subresourceRange)),
159 range_generator(im->range_encoder, normalized_subresource_range),
Jeff Bolze7fc67b2019-10-04 12:29:31 -0500160 samplerConversion(VK_NULL_HANDLE),
161 image_state(im) {
John Zulauff660ad62019-03-23 07:16:05 -0600162 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
163 if (conversionInfo) samplerConversion = conversionInfo->conversion;
164 if (image_state) {
165 // A light normalization of the createInfo range
166 auto &sub_res_range = create_info.subresourceRange;
167 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
168 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
169
170 // Cache a full normalization (for "full image/whole image" comparisons)
John Zulaufb58415b2019-12-09 15:02:32 -0700171 // normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500172 samples = image_state->createInfo.samples;
173 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600174 }
175}
176
Dave Houltond9611312018-11-19 17:03:36 -0700177uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
178 // uint cast applies floor()
179 return 1u + (uint32_t)log2(std::max({height, width, depth}));
180}
181
182uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
183
184uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
185
John Zulaufb58415b2019-12-09 15:02:32 -0700186static VkImageSubresourceRange NormalizeSubresourceRange(const VkImageCreateInfo &image_create_info,
187 const VkImageSubresourceRange &range) {
John Zulauff660ad62019-03-23 07:16:05 -0600188 VkImageSubresourceRange norm = range;
189 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
190
191 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
192 // <arrayLayers> can potentially alias.
193 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
194 ? image_create_info.extent.depth
195 : image_create_info.arrayLayers;
196 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
197
198 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
199 VkImageAspectFlags &aspect_mask = norm.aspectMask;
200 if (FormatIsMultiplane(image_create_info.format)) {
201 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
202 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
203 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
204 if (FormatPlaneCount(image_create_info.format) > 2) {
205 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
206 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208 }
John Zulauff660ad62019-03-23 07:16:05 -0600209 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700211
John Zulaufb58415b2019-12-09 15:02:32 -0700212VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
213 const VkImageCreateInfo &image_create_info = image_state.createInfo;
214 return NormalizeSubresourceRange(image_create_info, range);
215}
216
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700217template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700218void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700219 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700220 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
221 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
222 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
223 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600224 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700225 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
226 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
227 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700228 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700229}
230
231template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700232void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700233 if (imgpair.subresource.aspectMask & aspectMask) {
234 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700235 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700236 }
237}
238
Tony Barbourdf013b92017-01-25 12:53:48 -0700239// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600240void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700241 auto it = imageLayoutMap.find(imgpair);
242 if (it != imageLayoutMap.end()) {
243 it->second.layout = layout; // Update
244 } else {
245 imageLayoutMap[imgpair].layout = layout; // Insert
246 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700247}
248
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700249bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700250 if (!(imgpair.subresource.aspectMask & aspectMask)) {
251 return false;
252 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700253 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
254 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600255 auto imgsubIt = imageLayoutMap.find(imgpair);
256 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700257 return false;
258 }
259 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200260 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 -0600261 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600262 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700263 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700264 string_VkImageLayout(imgsubIt->second.layout));
265 }
266 layout = imgsubIt->second.layout;
267 return true;
268}
269
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700270// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700271bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700272 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700273 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
274 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
275 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
276 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600277 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700278 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
279 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
280 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700281 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700282 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
283 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600284 auto imgsubIt = imageLayoutMap.find(imgpair);
285 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700286 layout = imgsubIt->second.layout;
287 }
288 return true;
289}
290
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500291bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) const {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600292 auto sub_data = imageSubresourceMap.find(image);
293 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700294 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700295 if (!image_state) return false;
296 bool ignoreGlobal = false;
297 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
298 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
299 ignoreGlobal = true;
300 }
301 for (auto imgsubpair : sub_data->second) {
302 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600303 auto img_data = imageLayoutMap.find(imgsubpair);
304 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700305 layouts.push_back(img_data->second.layout);
306 }
307 }
308 return true;
309}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700310
John Zulauf3b04ebd2019-07-18 14:08:11 -0600311bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
312 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700313 if (!(imgpair.subresource.aspectMask & aspectMask)) {
314 return false;
315 }
316 imgpair.subresource.aspectMask = aspectMask;
317 auto imgsubIt = imageLayoutMap.find(imgpair);
318 if (imgsubIt == imageLayoutMap.end()) {
319 return false;
320 }
321 layout = imgsubIt->second.layout;
322 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700323}
Tony Barbourdf013b92017-01-25 12:53:48 -0700324
325// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600326bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
327 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700328 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
329 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
330 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
331 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
332 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600333 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700334 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
335 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
336 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
337 }
338 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700339 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
340 imgpair = {imgpair.image, false, VkImageSubresource()};
341 auto imgsubIt = imageLayoutMap.find(imgpair);
342 if (imgsubIt == imageLayoutMap.end()) return false;
343 layout = imgsubIt->second.layout;
344 }
345 return true;
346}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700347
348// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700349void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700350 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600351 auto data = imageLayoutMap.find(imgpair);
352 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700353 data->second.layout = layout; // Update
354 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600355 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700356 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600357 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700358 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
359 if (subresource == image_subresources.end()) {
360 image_subresources.push_back(imgpair);
361 }
362}
363
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600364// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600365void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600366 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
367 VkImageLayout expected_layout) {
368 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
369 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600370 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600371 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700372 }
373}
John Zulauff660ad62019-03-23 07:16:05 -0600374
375// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600376void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500377 if (disabled.image_layout_validation) {
378 return;
379 }
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500380 IMAGE_STATE *image_state = view_state.image_state.get();
381 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb58415b2019-12-09 15:02:32 -0700382 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, layout, view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600383}
384
385// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600386void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600387 const VkImageSubresourceRange &range, VkImageLayout layout) {
388 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
389 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600390 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600391}
392
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600393void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600394 VkImageLayout layout) {
395 const IMAGE_STATE *image_state = GetImageState(image);
396 if (!image_state) return;
397 SetImageInitialLayout(cb_node, *image_state, range, layout);
398};
399
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600400void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600401 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
402 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600403}
Dave Houltonddd65c52018-05-08 14:58:01 -0600404
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600405// Set image layout for all slices of an image view
Piers Daniell4fde9b72019-11-27 16:19:46 -0700406void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout,
407 VkImageLayout layoutStencil) {
Jeff Bolzfaffeb32019-10-04 12:47:16 -0500408 IMAGE_STATE *image_state = view_state.image_state.get();
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600409
John Zulauff660ad62019-03-23 07:16:05 -0600410 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600411 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
412 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600413 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 -0600414 sub_range.baseArrayLayer = 0;
415 sub_range.layerCount = image_state->createInfo.extent.depth;
416 }
417
Piers Daniell4fde9b72019-11-27 16:19:46 -0700418 if (sub_range.aspectMask == (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT) && layoutStencil != kInvalidLayout) {
419 sub_range.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
420 SetImageLayout(cb_node, *image_state, sub_range, layout);
421 sub_range.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
422 SetImageLayout(cb_node, *image_state, sub_range, layoutStencil);
423 } else {
424 SetImageLayout(cb_node, *image_state, sub_range, layout);
425 }
John Zulauf4ccf5c02018-09-21 11:46:18 -0600426}
427
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700428bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
429 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700430 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600431 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100432 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700433 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100434 const char *vuid;
435 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
436
437 if (!image_state) {
438 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
439 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600440 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700441 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
442 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100443 return skip;
444 }
445
446 auto image_usage = image_state->createInfo.usage;
447
448 // Check for layouts that mismatch image usages in the framebuffer
449 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800450 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451 skip |=
452 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -0600453 "Layout/usage mismatch for attachment %u in %s"
454 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_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_SHADER_READ_ONLY_OPTIMAL &&
461 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800462 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100463 skip |=
464 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 -0600465 "Layout/usage mismatch for attachment %u in %s"
466 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100467 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600468 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
469 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100470 }
471
472 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800473 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100474 skip |=
475 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 -0600476 "Layout/usage mismatch for attachment %u in %s"
477 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100478 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600479 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
480 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100481 }
482
483 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800484 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
Tobias Hectorbbb12282018-10-22 15:17:59 +0100485 skip |=
486 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 -0600487 "Layout/usage mismatch for attachment %u in %s"
488 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100489 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600490 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
491 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100492 }
493
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600494 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100495 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
496 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
497 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
498 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
499 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -0800500 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700501 skip |= log_msg(
502 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 -0600503 "Layout/usage mismatch for attachment %u in %s"
504 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700505 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600506 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
507 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508 }
509 } else {
510 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
511 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
512 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
513 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
514 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
515 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600516 "Layout/usage mismatch for attachment %u in %s"
517 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100518 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600519 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
520 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700521 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 }
523 }
524 return skip;
525}
526
John Zulauf17a01bb2019-08-09 16:41:19 -0600527bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700528 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600529 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600530 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700531 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700532 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100533 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100534
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700535 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100536 auto framebuffer = framebuffer_state->framebuffer;
537
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700538 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600539 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 -0600540 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700541 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700542 }
John Zulauf8e308292018-09-21 11:34:37 -0600543
Tobias Hectorc9057422019-07-23 12:15:52 +0100544 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
545 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
546 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100547 }
548
Tobias Hectorc9057422019-07-23 12:15:52 +0100549 if (attachments != nullptr) {
550 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
551 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
552 auto image_view = attachments[i];
553 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100554
Tobias Hectorc9057422019-07-23 12:15:52 +0100555 if (!view_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 is not a valid VkImageView handle",
559 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
560 report_data->FormatHandle(image_view).c_str());
561 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100562 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100563
564 const VkImage image = view_state->create_info.image;
565 const IMAGE_STATE *image_state = GetImageState(image);
566
567 if (!image_state) {
568 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
569 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
570 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
571 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
572 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
573 continue;
574 }
575 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
576 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
577
Piers Daniell7f894f62020-01-09 16:33:48 -0700578 // Default to expecting stencil in the same layout.
579 auto attachment_stencil_initial_layout = attachment_initial_layout;
580
581 // If a separate layout is specified, look for that.
582 const auto *attachment_description_stencil_layout =
583 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
584 if (attachment_description_stencil_layout) {
585 attachment_stencil_initial_layout = attachment_description_stencil_layout->stencilInitialLayout;
586 }
587
Tobias Hectorc9057422019-07-23 12:15:52 +0100588 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
589 // in common with the non-const version.)
590 const ImageSubresourceLayoutMap *subresource_map =
591 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
592
593 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
594 LayoutUseCheckAndMessage layout_check(subresource_map);
595 bool subres_skip = false;
John Zulauf5e617452019-11-19 14:44:16 -0700596 auto pos = subresource_map->Find(view_state->normalized_subresource_range);
597 for (; pos != subresource_map->End() && !subres_skip; ++pos) {
598 const VkImageSubresource &subres = pos->subresource;
Piers Daniell7f894f62020-01-09 16:33:48 -0700599
John Zulauf5e617452019-11-19 14:44:16 -0700600 // Allow for differing depth and stencil layouts
601 VkImageLayout check_layout = attachment_initial_layout;
602 if (subres.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) check_layout = attachment_stencil_initial_layout;
603
604 if (!layout_check.Check(subres, check_layout, pos->current_layout, pos->initial_layout)) {
Piers Daniell7f894f62020-01-09 16:33:48 -0700605 subres_skip |= log_msg(
606 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
607 kVUID_Core_DrawState_InvalidRenderpass,
608 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
609 "and the %s layout of the attachment is %s. The layouts must match, or the render "
610 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
John Zulauf5e617452019-11-19 14:44:16 -0700611 i, string_VkImageLayout(check_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobias Hectorc9057422019-07-23 12:15:52 +0100612 }
Piers Daniell7f894f62020-01-09 16:33:48 -0700613 }
John Zulauf5e617452019-11-19 14:44:16 -0700614
Tobias Hectorc9057422019-07-23 12:15:52 +0100615 skip |= subres_skip;
616 }
617
618 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
619 framebuffer, render_pass, i, "initial layout");
620
621 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
622 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100623 }
624
Tobias Hectorc9057422019-07-23 12:15:52 +0100625 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
626 auto &subpass = pRenderPassInfo->pSubpasses[j];
627 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
628 auto &attachment_ref = subpass.pInputAttachments[k];
629 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
630 auto image_view = attachments[attachment_ref.attachment];
631 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100632
Tobias Hectorc9057422019-07-23 12:15:52 +0100633 if (view_state) {
634 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700635 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
636 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100637 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100638 }
639 }
640 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100641
Tobias Hectorc9057422019-07-23 12:15:52 +0100642 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
643 auto &attachment_ref = subpass.pColorAttachments[k];
644 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
645 auto image_view = attachments[attachment_ref.attachment];
646 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100647
Tobias Hectorc9057422019-07-23 12:15:52 +0100648 if (view_state) {
649 auto image = view_state->create_info.image;
650 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
651 framebuffer, render_pass, attachment_ref.attachment,
652 "color attachment layout");
653 if (subpass.pResolveAttachments) {
654 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
655 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
656 attachment_ref.attachment, "resolve attachment layout");
657 }
658 }
659 }
660 }
661
662 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
663 auto &attachment_ref = *subpass.pDepthStencilAttachment;
664 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
665 auto image_view = attachments[attachment_ref.attachment];
666 auto view_state = GetImageViewState(image_view);
667
668 if (view_state) {
669 auto image = view_state->create_info.image;
670 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
671 framebuffer, render_pass, attachment_ref.attachment,
672 "input attachment layout");
673 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100674 }
675 }
676 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700677 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600678 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700679}
680
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600681void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mike Schuchardtf6f00492019-10-21 23:35:17 -0700682 const safe_VkAttachmentReference2 &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700683 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700684 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600685 if (image_view) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700686 VkImageLayout stencil_layout = kInvalidLayout;
687 const auto *attachment_reference_stencil_layout = lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(ref.pNext);
688 if (attachment_reference_stencil_layout) {
689 stencil_layout = attachment_reference_stencil_layout->stencilLayout;
690 }
691
692 SetImageViewLayout(pCB, *image_view, ref.layout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600693 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700694 }
695}
696
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600697void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
698 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700699 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700700
701 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700702 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700703 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700704 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700705 }
706 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700707 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700708 }
709 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700710 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700711 }
712 }
713}
714
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700715// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
716// 1. Transition into initialLayout state
717// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600718void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700719 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700720 // First transition into initialLayout
721 auto const rpci = render_pass_state->createInfo.ptr();
722 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700723 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600724 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -0700725 VkImageLayout stencil_layout = kInvalidLayout;
726 const auto *attachment_description_stencil_layout =
727 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(rpci->pAttachments[i].pNext);
728 if (attachment_description_stencil_layout) {
729 stencil_layout = attachment_description_stencil_layout->stencilInitialLayout;
730 }
731
732 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -0600733 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700734 }
735 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700736 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700737}
738
Dave Houlton10b39482017-03-16 13:18:15 -0600739bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600740 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600741 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600742 }
743 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600744 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600745 }
746 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600747 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600748 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700749 if (0 !=
750 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
751 if (FormatPlaneCount(format) == 1) return false;
752 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600753 return true;
754}
755
Mike Weiblen62d08a32017-03-07 22:18:27 -0700756// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200757bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
758 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600759 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700760 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200761 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600762 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700763
764 switch (layout) {
765 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
766 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600767 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700768 }
769 break;
770 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
771 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600772 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700773 }
774 break;
775 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
776 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600777 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700778 }
779 break;
780 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
781 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600782 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700783 }
784 break;
785 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
786 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600787 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700788 }
789 break;
790 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
791 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600792 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700793 }
794 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600795 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500796 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
797 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
798 }
799 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700800 default:
801 // Other VkImageLayout values do not have VUs defined in this context.
802 break;
803 }
804
Dave Houlton8e9f6542018-05-18 12:18:22 -0600805 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600806 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200807 HandleToUint64(img_barrier.image), msg_code,
808 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
809 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
810 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700811 }
812 return skip;
813}
814
815// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600816bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
817 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700818 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700819
Petr Krausad0096a2019-08-09 18:35:04 +0200820 // Scoreboard for checking for duplicate and inconsistent barriers to images
821 struct ImageBarrierScoreboardEntry {
822 uint32_t index;
823 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
824 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
825 const VkImageMemoryBarrier *barrier;
826 };
827 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
828 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
829
John Zulauf463c51e2018-05-31 13:29:20 -0600830 // Scoreboard for duplicate layout transition barriers within the list
831 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
832 ImageBarrierScoreboardImageMap layout_transitions;
833
Mike Weiblen62d08a32017-03-07 22:18:27 -0700834 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200835 const auto &img_barrier = pImageMemoryBarriers[i];
836 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700837
John Zulauf463c51e2018-05-31 13:29:20 -0600838 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
839 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
840 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200841 if (img_barrier.oldLayout != img_barrier.newLayout) {
842 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
843 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600844 if (image_it != layout_transitions.end()) {
845 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200846 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600847 if (subres_it != subres_map.end()) {
848 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200849 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
850 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
851 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600852 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700853 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
854 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200855 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600856 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
857 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200858 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
859 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
860 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600861 }
862 entry = new_entry;
863 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200864 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600865 }
866 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200867 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600868 }
869 }
870
Petr Krausad0096a2019-08-09 18:35:04 +0200871 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600872 if (image_state) {
873 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200874 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
875 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600876
877 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
878 if (image_state->layout_locked) {
879 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600880 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700881 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200882 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600883 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600884 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Petr Krausad0096a2019-08-09 18:35:04 +0200885 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
886 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600887 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600888
John Zulaufa4472282019-08-22 14:44:34 -0600889 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600890 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600891 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200892 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
Piers Daniell41b8c5d2020-01-10 15:42:00 -0700893 if (enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -0600894 if (!(aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
895 skip |=
896 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
897 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03319",
898 "%s: Image barrier %s references %s of format %s that must have either the depth or stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600899 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200900 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600901 string_VkFormat(image_create_info.format), aspect_mask);
Piers Daniell9af77cd2019-10-16 13:54:12 -0600902 }
903 } else {
904 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
905 if ((aspect_mask & ds_mask) != (ds_mask)) {
906 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
907 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-03320",
908 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
909 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
910 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
911 string_VkFormat(image_create_info.format), aspect_mask);
912 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700913 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700914 }
John Zulauff660ad62019-03-23 07:16:05 -0600915
Petr Krausad0096a2019-08-09 18:35:04 +0200916 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
917 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600918 // TODO: Set memory invalid which is in mem_tracker currently
919 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
920 // subresource.
921 } else if (subresource_map) {
922 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600923 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200924 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf5e617452019-11-19 14:44:16 -0700925 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
926 const auto &value = *pos;
927 if (!layout_check.Check(value.subresource, img_barrier.oldLayout, value.current_layout, value.initial_layout)) {
928 subres_skip = log_msg(
929 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
930 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
931 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
932 "%s layout is %s.",
933 report_data->FormatHandle(img_barrier.image).c_str(), value.subresource.aspectMask,
934 value.subresource.mipLevel, value.subresource.arrayLayer, string_VkImageLayout(img_barrier.oldLayout),
935 layout_check.message, string_VkImageLayout(layout_check.layout));
John Zulauff660ad62019-03-23 07:16:05 -0600936 }
John Zulauf5e617452019-11-19 14:44:16 -0700937 }
John Zulauff660ad62019-03-23 07:16:05 -0600938 skip |= subres_skip;
939 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700940 }
941 }
942 return skip;
943}
944
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600945bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200946 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700947
Jeff Bolz6835fda2019-10-06 00:15:34 -0500948 auto pool = cb_state->command_pool.get();
Petr Krausad0096a2019-08-09 18:35:04 +0200949 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700950}
951
John Zulauf6b4aae82018-05-09 13:03:36 -0600952template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600953bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
954 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600955 using BarrierRecord = QFOTransferBarrier<Barrier>;
956 bool skip = false;
Jeff Bolz6835fda2019-10-06 00:15:34 -0500957 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -0600958 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
959 const char *barrier_name = BarrierRecord::BarrierName();
960 const char *handle_name = BarrierRecord::HandleName();
961 const char *transfer_type = nullptr;
962 for (uint32_t b = 0; b < barrier_count; b++) {
963 if (!IsTransferOp(&barriers[b])) continue;
964 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700965 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600966 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600967 const auto found = barrier_sets.release.find(barriers[b]);
968 if (found != barrier_sets.release.cend()) {
969 barrier_record = &(*found);
970 transfer_type = "releasing";
971 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600972 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600973 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600974 const auto found = barrier_sets.acquire.find(barriers[b]);
975 if (found != barrier_sets.acquire.cend()) {
976 barrier_record = &(*found);
977 transfer_type = "acquiring";
978 }
979 }
980 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700981 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
982 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
983 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
984 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
985 func_name, barrier_name, b, transfer_type, handle_name,
986 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
987 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600988 }
989 }
990 return skip;
991}
992
John Zulaufa4472282019-08-22 14:44:34 -0600993VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
994 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
995}
996
997const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
998 return device_state.GetImageState(barrier.image);
999}
1000
1001VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
1002 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
1003}
1004
1005const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
1006 return device_state.GetBufferState(barrier.buffer);
1007}
1008
1009VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
1010
John Zulauf6b4aae82018-05-09 13:03:36 -06001011template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -06001012void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
1013 const Barrier *barriers) {
Jeff Bolz6835fda2019-10-06 00:15:34 -05001014 auto pool = cb_state->command_pool.get();
John Zulauf6b4aae82018-05-09 13:03:36 -06001015 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
1016 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -06001017 auto &barrier = barriers[b];
1018 if (IsTransferOp(&barrier)) {
1019 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
1020 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
1021 barrier_sets.release.emplace(barrier);
1022 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
1023 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
1024 barrier_sets.acquire.emplace(barrier);
1025 }
1026 }
1027
1028 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
1029 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
1030 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
1031 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
1032 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
1033 auto handle_state = BarrierHandleState(*this, barrier);
1034 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
1035 if (!mode_concurrent) {
1036 const auto typed_handle = BarrierTypedHandle(barrier);
Jeff Bolz310775c2019-10-09 00:46:33 -05001037 cb_state->queue_submit_functions.emplace_back(
1038 [func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](
1039 const ValidationStateTracker *device_data, const QUEUE_STATE *queue_state) {
1040 return ValidateConcurrentBarrierAtSubmit(device_data, queue_state, func_name, cb_state, typed_handle,
1041 src_queue_family, dst_queue_family);
John Zulaufa4472282019-08-22 14:44:34 -06001042 });
1043 }
John Zulauf6b4aae82018-05-09 13:03:36 -06001044 }
1045 }
1046}
1047
John Zulaufa4472282019-08-22 14:44:34 -06001048bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001049 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001050 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -06001051 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001052 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001053 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1054 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001055 return skip;
1056}
1057
John Zulaufa4472282019-08-22 14:44:34 -06001058void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
1059 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
1060 const VkImageMemoryBarrier *pImageMemBarriers) {
1061 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
1062 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001063}
1064
1065template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001066bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001067 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001068 // Record to the scoreboard or report that we have a duplication
1069 bool skip = false;
1070 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1071 if (!inserted.second && inserted.first->second != cb_state) {
1072 // 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 -07001073 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1074 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1075 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -06001076 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -07001077 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1078 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001079 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001080 }
1081 return skip;
1082}
1083
1084template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001085bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1086 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001087 using BarrierRecord = QFOTransferBarrier<Barrier>;
1088 using TypeTag = typename BarrierRecord::Tag;
1089 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001090 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001091 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001092 const char *barrier_name = BarrierRecord::BarrierName();
1093 const char *handle_name = BarrierRecord::HandleName();
1094 // No release should have an extant duplicate (WARNING)
1095 for (const auto &release : cb_barriers.release) {
1096 // Check the global pending release barriers
1097 const auto set_it = global_release_barriers.find(release.handle);
1098 if (set_it != global_release_barriers.cend()) {
1099 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1100 const auto found = set_for_handle.find(release);
1101 if (found != set_for_handle.cend()) {
1102 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1103 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001104 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001105 " to dstQueueFamilyIndex %" PRIu32
1106 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001107 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001108 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1109 }
1110 }
1111 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1112 }
1113 // Each acquire must have a matching release (ERROR)
1114 for (const auto &acquire : cb_barriers.acquire) {
1115 const auto set_it = global_release_barriers.find(acquire.handle);
1116 bool matching_release_found = false;
1117 if (set_it != global_release_barriers.cend()) {
1118 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1119 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1120 }
1121 if (!matching_release_found) {
1122 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1123 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001124 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1125 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1126 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001127 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1128 }
1129 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1130 }
1131 return skip;
1132}
1133
John Zulauf3b04ebd2019-07-18 14:08:11 -06001134bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001135 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001136 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001137 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001138 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1139 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001140 return skip;
1141}
1142
1143template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001144void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001145 using BarrierRecord = QFOTransferBarrier<Barrier>;
1146 using TypeTag = typename BarrierRecord::Tag;
1147 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001148 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001149
1150 // Add release barriers from this submit to the global map
1151 for (const auto &release : cb_barriers.release) {
1152 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1153 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1154 global_release_barriers[release.handle].insert(release);
1155 }
1156
1157 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1158 for (const auto &acquire : cb_barriers.acquire) {
1159 // NOTE: We're not using [] because we don't want to create entries for missing releases
1160 auto set_it = global_release_barriers.find(acquire.handle);
1161 if (set_it != global_release_barriers.end()) {
1162 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1163 set_for_handle.erase(acquire);
1164 if (set_for_handle.size() == 0) { // Clean up empty sets
1165 global_release_barriers.erase(set_it);
1166 }
1167 }
1168 }
1169}
1170
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001171void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001172 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1173 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001174}
1175
John Zulauf6b4aae82018-05-09 13:03:36 -06001176// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001177void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001178
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001179void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001180 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001181 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001182 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001183
Chris Forbes4de4b132017-08-21 11:27:08 -07001184 // For ownership transfers, the barrier is specified twice; as a release
1185 // operation on the yielding queue family, and as an acquire operation
1186 // on the acquiring queue family. This barrier may also include a layout
1187 // transition, which occurs 'between' the two operations. For validation
1188 // purposes it doesn't seem important which side performs the layout
1189 // transition, but it must not be performed twice. We'll arbitrarily
1190 // choose to perform it as part of the acquire operation.
John Zulauf2be3fe02019-12-30 09:48:02 -07001191 //
1192 // However, we still need to record initial layout for the "initial layout" validation
1193 const bool is_release_op = IsReleaseOp(cb_state, mem_barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -07001194
Petr Krausad0096a2019-08-09 18:35:04 +02001195 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001196 if (!image_state) continue;
John Zulauf2be3fe02019-12-30 09:48:02 -07001197 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
unknown86bcb3a2019-07-11 13:05:36 -06001198 for (const auto &image : image_state->aliasing_images) {
1199 image_state = GetImageState(image);
John Zulauf2be3fe02019-12-30 09:48:02 -07001200 RecordTransitionImageLayout(cb_state, image_state, mem_barrier, is_release_op);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001201 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001202 }
1203}
1204
unknown86bcb3a2019-07-11 13:05:36 -06001205void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
John Zulauf2be3fe02019-12-30 09:48:02 -07001206 const VkImageMemoryBarrier &mem_barrier, bool is_release_op) {
unknown86bcb3a2019-07-11 13:05:36 -06001207 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1208 const auto &image_create_info = image_state->createInfo;
1209
1210 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1211 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1212 // for all (potential) layer sub_resources.
1213 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1214 normalized_isr.baseArrayLayer = 0;
1215 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1216 }
1217
John Zulauf2be3fe02019-12-30 09:48:02 -07001218 if (is_release_op) {
1219 SetImageInitialLayout(cb_state, *image_state, normalized_isr, mem_barrier.oldLayout);
1220 } else {
1221 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1222 }
unknown86bcb3a2019-07-11 13:05:36 -06001223}
1224
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001225bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1226 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1227 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1228 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001229 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001230 assert(cb_node);
1231 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001232 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001233 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001234
John Zulauff660ad62019-03-23 07:16:05 -06001235 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1236 if (subresource_map) {
1237 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001238 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
John Zulauf5e617452019-11-19 14:44:16 -07001239 for (auto pos = subresource_map->Find(range); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1240 if (!layout_check.Check(pos->subresource, explicit_layout, pos->current_layout, pos->initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001241 *error = true;
John Zulauf5e617452019-11-19 14:44:16 -07001242 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1243 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1244 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1245 "%s layout %s.",
1246 caller, report_data->FormatHandle(image).c_str(), pos->subresource.arrayLayer,
1247 pos->subresource.mipLevel, string_VkImageLayout(explicit_layout), layout_check.message,
1248 string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001249 }
John Zulauf5e617452019-11-19 14:44:16 -07001250 }
John Zulauff660ad62019-03-23 07:16:05 -06001251 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001252 }
John Zulauff660ad62019-03-23 07:16:05 -06001253
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001254 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1255 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1256 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001257 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1258 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001259 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001260 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001261 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001262 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001263 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001264 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001265 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001266 if (image_state->shared_presentable) {
1267 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001268 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1269 layout_invalid_msg_code,
1270 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1271 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001272 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001273 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001274 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001275 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001276 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 -07001277 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001278 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001279 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1280 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001281 }
1282 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001283 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001284}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001285bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001286 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1287 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001288 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001289 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1290 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1291}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001292
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001293void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001294 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001295 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001296 if (!renderPass) return;
1297
Tobias Hectorbbb12282018-10-22 15:17:59 +01001298 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001299 if (framebuffer_state) {
1300 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001301 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001302 if (view_state) {
Piers Daniell4fde9b72019-11-27 16:19:46 -07001303 VkImageLayout stencil_layout = kInvalidLayout;
1304 const auto *attachment_description_stencil_layout =
1305 lvl_find_in_chain<VkAttachmentDescriptionStencilLayoutKHR>(pRenderPassInfo->pAttachments[i].pNext);
1306 if (attachment_description_stencil_layout) {
1307 stencil_layout = attachment_description_stencil_layout->stencilFinalLayout;
1308 }
1309
1310 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout, stencil_layout);
John Zulauf8e308292018-09-21 11:34:37 -06001311 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001312 }
1313 }
1314}
Dave Houltone19e20d2018-02-02 16:32:41 -07001315
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316#ifdef VK_USE_PLATFORM_ANDROID_KHR
1317// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1318// This could also move into a seperate core_validation_android.cpp file... ?
1319
1320//
1321// AHB-specific validation within non-AHB APIs
1322//
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001323bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001324 bool skip = false;
1325
1326 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1327 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001328 if (0 != ext_fmt_android->externalFormat) {
1329 if (VK_FORMAT_UNDEFINED != create_info->format) {
1330 skip |=
1331 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1332 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001333 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001334 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1335 }
1336
1337 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1339 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001340 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001341 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1342 }
1343
1344 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1345 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1346 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001347 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001348 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1349 }
1350
1351 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1352 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1353 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001354 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001355 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1356 }
1357 }
1358
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001359 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001360 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1361 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001362 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001363 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1364 }
1365 }
1366
Dave Houltond9611312018-11-19 17:03:36 -07001367 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001368 if (VK_FORMAT_UNDEFINED == create_info->format) {
1369 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1370 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001371 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001372 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1373 }
1374 }
1375
1376 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1377 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1378 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001379 skip |=
1380 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1381 "VUID-VkImageCreateInfo-pNext-02393",
1382 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1383 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1384 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001385 }
1386
1387 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1388 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1389 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001390 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001391 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1392 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1393 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1394 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001395 }
1396
1397 return skip;
1398}
1399
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001400bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001401 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001402 const IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001403
1404 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001405 if (VK_FORMAT_UNDEFINED != create_info->format) {
1406 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1407 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1408 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1409 "format member is %s.",
1410 string_VkFormat(create_info->format));
1411 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001412
Dave Houltond9611312018-11-19 17:03:36 -07001413 // Chain must include a compatible ycbcr conversion
1414 bool conv_found = false;
1415 uint64_t external_format = 0;
1416 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1417 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001418 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001419 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001420 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001421 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001422 }
Dave Houltond9611312018-11-19 17:03:36 -07001423 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001424 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001425 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 -07001426 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1427 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1428 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1429 }
1430
1431 // Errors in create_info swizzles
1432 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1433 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1434 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1435 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1437 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1438 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1439 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001440 }
1441 }
Dave Houltond9611312018-11-19 17:03:36 -07001442
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001443 return skip;
1444}
1445
John Zulaufa26d3c82019-08-14 16:09:08 -06001446bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001448
John Zulaufa26d3c82019-08-14 16:09:08 -06001449 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001450 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1451 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1452 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001453 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001454 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1455 "bound to memory.");
1456 }
1457 return skip;
1458}
1459
1460#else
1461
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001462bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001463 return false;
1464}
1465
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001466bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001467
John Zulaufa26d3c82019-08-14 16:09:08 -06001468bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001469
1470#endif // VK_USE_PLATFORM_ANDROID_KHR
1471
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001472bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001473 const VkAllocationCallbacks *pAllocator, VkImage *pImage) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001474 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001475
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001476 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001477 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001478 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1479 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1480 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1481 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001482 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001483 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001484 }
1485
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001486 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1487 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1488 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1489 "VUID-VkImageCreateInfo-flags-00949",
1490 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1491 "flag bit is set");
1492 }
1493
1494 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1496 "VUID-VkImageCreateInfo-imageType-00954",
1497 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1498 "height (%d) and arrayLayers (%d) must be >= 6.",
1499 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1500 }
Dave Houlton130c0212018-01-29 13:39:56 -07001501 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001502
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001503 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001504 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1505 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1506 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001507 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 +00001508 "VUID-VkImageCreateInfo-usage-00964",
1509 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1510 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001511 }
1512
1513 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001514 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 +00001515 "VUID-VkImageCreateInfo-usage-00965",
1516 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1517 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001518 }
1519
ByumjinConffx991b6062019-08-14 15:17:53 -07001520 if (device_extensions.vk_ext_fragment_density_map) {
1521 uint32_t ceiling_width =
1522 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1523 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1524 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1525 skip |=
1526 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1527 "VUID-VkImageCreateInfo-usage-02559",
1528 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1529 "ceiling of device "
1530 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1531 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1532 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1533 }
1534
1535 uint32_t ceiling_height =
1536 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1537 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1538 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1539 skip |=
1540 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1541 "VUID-VkImageCreateInfo-usage-02560",
1542 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1543 "ceiling of device "
1544 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1545 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1546 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1547 }
1548 }
1549
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001550 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001551 VkResult result = VK_SUCCESS;
1552 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1553 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1554 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1555 &format_limits);
1556 } else {
1557 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1558 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1559 image_format_info.type = pCreateInfo->imageType;
1560 image_format_info.tiling = pCreateInfo->tiling;
1561 image_format_info.usage = pCreateInfo->usage;
1562 image_format_info.flags = pCreateInfo->flags;
1563 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1564 format_limits = image_format_properties.imageFormatProperties;
1565 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001566
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001567 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001568#ifdef VK_USE_PLATFORM_ANDROID_KHR
1569 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1570#endif // VK_USE_PLATFORM_ANDROID_KHR
1571 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1572 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1573 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001574 } else {
1575 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1576 const char *format_string = string_VkFormat(pCreateInfo->format);
1577 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1578 "VUID-VkImageCreateInfo-mipLevels-02255",
1579 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1580 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1581 }
Dave Houlton130c0212018-01-29 13:39:56 -07001582
Dave Houltona585d132019-01-18 13:05:42 -07001583 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1584 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1585 (uint64_t)pCreateInfo->samples;
1586 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001587
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001588 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001589 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001590 uint64_t ig_mask = imageGranularity - 1;
1591 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001592
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001593 if (total_size > format_limits.maxResourceSize) {
1594 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1595 kVUID_Core_Image_InvalidFormatLimitsViolation,
1596 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1597 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1598 total_size, format_limits.maxResourceSize);
1599 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001600
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001601 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1602 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1603 "VUID-VkImageCreateInfo-arrayLayers-02256",
1604 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1605 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1606 }
1607
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001608 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1609 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001610 skip |= log_msg(
1611 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1612 "VUID-VkImageCreateInfo-format-02653",
1613 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1614 pCreateInfo->arrayLayers);
1615 }
1616
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001617 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1618 skip |=
1619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1620 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001621 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001622 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001623 }
1624
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001625 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001626 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 -06001627 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001628 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1629 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001630 }
1631
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001632 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001633 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1634 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1635 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1636 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001637 skip |=
1638 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1639 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1640 "format must be block, ETC or ASTC compressed, but is %s",
1641 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001642 }
1643 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1644 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001645 skip |=
1646 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1647 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1648 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001649 }
1650 }
1651 }
1652
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001653 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001654 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1655 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1656 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001657 }
1658
unknown2c877272019-07-11 12:56:50 -06001659 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1660 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1661 skip |=
1662 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1663 "VUID-VkImageCreateInfo-format-01577",
1664 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1665 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1666 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001667 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001668}
1669
John Zulauf7eeb6f72019-06-17 11:56:36 -06001670void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1671 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1672 if (VK_SUCCESS != result) return;
1673
1674 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1675
1676 IMAGE_LAYOUT_STATE image_state;
1677 image_state.layout = pCreateInfo->initialLayout;
1678 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001679 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001680 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001681 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001682}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001683
Jeff Bolz5c801d12019-10-09 10:38:45 -05001684bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05001685 const IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001686 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001687 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001688 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001689 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001690 }
1691 return skip;
1692}
1693
John Zulauf7eeb6f72019-06-17 11:56:36 -06001694void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1695 // Clean up validation specific data
1696 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001697
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001698 const auto &sub_entry = imageSubresourceMap.find(image);
1699 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001700 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001701 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001702 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001703 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001704 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001705
1706 // Clean up generic image state
1707 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001708}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001709
John Zulauf07288512019-07-05 11:09:50 -06001710bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001711 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001712
1713 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1714 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1715 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 -06001716 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001717 }
1718
Dave Houlton1d2022c2017-03-29 11:43:58 -06001719 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001720 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1721 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 -06001722 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001723 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001724 char const str[] = "vkCmdClearColorImage called with compressed image.";
1725 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 -06001726 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001727 }
1728
1729 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1730 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1731 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 -06001732 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001733 }
1734 return skip;
1735}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001736
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001737uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1738 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1739 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001740 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001741 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001742 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001743 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001744}
1745
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001746uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1747 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1748 uint32_t array_layer_count = range->layerCount;
1749 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1750 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001751 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001752 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753}
1754
John Zulauf07288512019-07-05 11:09:50 -06001755bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1756 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1757 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001758 bool skip = false;
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001759 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1760 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001761 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 -07001762 HandleToUint64(image_state->image), "VUID-vkCmdClearDepthStencilImage-imageLayout-00012",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001763 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1764 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001765 }
Mark Lobodzinskia4651ba2019-12-18 12:57:46 -07001766
1767 } else {
1768 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1769 if (!device_extensions.vk_khr_shared_presentable_image) {
1770 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL)) {
1771 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1772 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-00005",
1773 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1774 string_VkImageLayout(dest_image_layout));
1775 }
1776 } else {
1777 if ((dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) && (dest_image_layout != VK_IMAGE_LAYOUT_GENERAL) &&
1778 (dest_image_layout != VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR)) {
1779 skip |= log_msg(
1780 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1781 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-imageLayout-01394",
1782 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL, SHARED_PRESENT_KHR, or GENERAL.",
1783 func_name, string_VkImageLayout(dest_image_layout));
1784 }
1785 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001786 }
1787
John Zulauff660ad62019-03-23 07:16:05 -06001788 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001789 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001790 if (subresource_map) {
1791 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001792 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001793 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf5e617452019-11-19 14:44:16 -07001794 for (auto pos = subresource_map->Find(normalized_isr); (pos != subresource_map->End()) && !subres_skip; ++pos) {
1795 if (!layout_check.Check(pos->subresource, dest_image_layout, pos->current_layout, pos->initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001796 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1797 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1798 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1799 } else {
1800 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001801 }
John Zulauff660ad62019-03-23 07:16:05 -06001802 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1803 HandleToUint64(cb_node->commandBuffer), error_code,
1804 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1805 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1806 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001807 }
John Zulauf5e617452019-11-19 14:44:16 -07001808 }
John Zulauff660ad62019-03-23 07:16:05 -06001809 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001810 }
1811
1812 return skip;
1813}
1814
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001815bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1816 const VkClearColorValue *pColor, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001817 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001818 bool skip = false;
1819 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001820 const auto *cb_node = GetCBState(commandBuffer);
1821 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001822 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001823 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001824 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001825 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001826 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001827 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001828 skip |=
1829 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1830 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001831 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001832 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001833 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001834 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001835 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001836 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1837 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001838 }
1839 }
1840 return skip;
1841}
1842
John Zulaufeabb4462019-07-05 14:13:03 -06001843void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1844 const VkClearColorValue *pColor, uint32_t rangeCount,
1845 const VkImageSubresourceRange *pRanges) {
1846 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1847
1848 auto cb_node = GetCBState(commandBuffer);
1849 auto image_state = GetImageState(image);
1850 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001851 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001852 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001853 }
1854 }
1855}
1856
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001857bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1858 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001859 const VkImageSubresourceRange *pRanges) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001860 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001861
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001862 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001863 const auto *cb_node = GetCBState(commandBuffer);
1864 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001865 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001866 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001867 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001868 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001869 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001870 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001871 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001872 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1873 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001874 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001875 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001876 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Andrew Fobel3abeb992020-01-20 16:33:22 -05001877
1878 bool any_include_aspect_depth_bit = false;
1879 bool any_include_aspect_stencil_bit = false;
1880
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001881 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001882 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001883 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001884 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001885 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001886 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1887 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001888 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001889 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1890 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001891 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 -06001892 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001893 }
Andrew Fobel3abeb992020-01-20 16:33:22 -05001894 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
1895 any_include_aspect_depth_bit = true;
1896 }
1897 if ((pRanges[i].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
1898 any_include_aspect_stencil_bit = true;
1899 }
1900 }
1901 if (any_include_aspect_stencil_bit) {
1902 const auto image_stencil_struct = lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
1903 if (image_stencil_struct != nullptr) {
1904 if ((image_stencil_struct->stencilUsage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1905 skip |=
1906 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1907 "VUID-vkCmdClearDepthStencilImage-pRanges-02658",
1908 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT "
1909 "and image was created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be "
1910 "included in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
1911 }
1912 } else {
1913 if ((image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1914 skip |= log_msg(
1915 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1916 "VUID-vkCmdClearDepthStencilImage-pRanges-02659",
1917 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_STENCIL_BIT and "
1918 "image was not created with separate stencil usage, VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included "
1919 "in VkImageCreateInfo::usage used to create image");
1920 }
1921 }
1922 }
1923 if (any_include_aspect_depth_bit && (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
1924 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1925 "VUID-vkCmdClearDepthStencilImage-pRanges-02660",
1926 "vkCmdClearDepthStencilImage(): an element of pRanges.aspect includes VK_IMAGE_ASPECT_DEPTH_BIT, "
1927 "VK_IMAGE_USAGE_TRANSFER_DST_BIT must be included in VkImageCreateInfo::usage used to create image");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001928 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001929 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001930 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001931 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 -06001932 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001933 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001934 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1935 char const str[] =
1936 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1937 "set.";
1938 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 -06001939 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001940 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001941 }
1942 return skip;
1943}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001944
John Zulaufeabb4462019-07-05 14:13:03 -06001945void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1946 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1947 const VkImageSubresourceRange *pRanges) {
1948 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1949 auto cb_node = GetCBState(commandBuffer);
1950 auto image_state = GetImageState(image);
1951 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001952 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001953 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001954 }
1955 }
1956}
1957
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001958// Returns true if [x, xoffset] and [y, yoffset] overlap
1959static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1960 bool result = false;
1961 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1962 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1963
1964 if (intersection_max > intersection_min) {
1965 result = true;
1966 }
1967 return result;
1968}
1969
Dave Houltonc991cc92018-03-06 11:08:51 -07001970// Returns true if source area of first copy region intersects dest area of second region
1971// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1972static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001973 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001974
Dave Houltonc991cc92018-03-06 11:08:51 -07001975 // Separate planes within a multiplane image cannot intersect
1976 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001977 return result;
1978 }
1979
Dave Houltonc991cc92018-03-06 11:08:51 -07001980 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1981 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1982 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001983 result = true;
1984 switch (type) {
1985 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001986 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001987 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001988 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001989 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001990 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001991 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001992 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001993 break;
1994 default:
1995 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1996 assert(false);
1997 }
1998 }
1999 return result;
2000}
2001
Dave Houltonfc1a4052017-04-27 14:32:45 -06002002// Returns non-zero if offset and extent exceed image extents
2003static const uint32_t x_bit = 1;
2004static const uint32_t y_bit = 2;
2005static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06002006static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002007 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002008 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002009 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
2010 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002011 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002012 }
2013 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
2014 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002015 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002016 }
2017 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
2018 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002019 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002020 }
2021 return result;
2022}
2023
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002024// Test if two VkExtent3D structs are equivalent
2025static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
2026 bool result = true;
2027 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
2028 (extent->depth != other_extent->depth)) {
2029 result = false;
2030 }
2031 return result;
2032}
2033
Dave Houltonee281a52017-12-08 13:51:02 -07002034// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
2035// Destination image texel extents must be adjusted by block size for the dest validation checks
2036VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
2037 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002038 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2039 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002040 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002041 adjusted_extent.width /= block_size.width;
2042 adjusted_extent.height /= block_size.height;
2043 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002044 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2045 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002046 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002047 adjusted_extent.width *= block_size.width;
2048 adjusted_extent.height *= block_size.height;
2049 adjusted_extent.depth *= block_size.depth;
2050 }
2051 return adjusted_extent;
2052}
2053
Dave Houlton6f9059e2017-05-02 17:15:13 -06002054// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2056 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002057
2058 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002059 if (mip >= img->createInfo.mipLevels) {
2060 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002061 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002062
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002063 // 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 -06002064 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002065
Dave Houltone48cd112019-01-03 17:01:18 -07002066 // If multi-plane, adjust per-plane extent
2067 if (FormatIsMultiplane(img->createInfo.format)) {
2068 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2069 extent.width /= divisors.width;
2070 extent.height /= divisors.height;
2071 }
2072
Jeff Bolzef40fec2018-09-01 22:04:34 -05002073 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2074 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002075 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002076 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2077 } else {
2078 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2079 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2080 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2081 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002082
Dave Houlton6f9059e2017-05-02 17:15:13 -06002083 // Image arrays have an effective z extent that isn't diminished by mip level
2084 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002085 extent.depth = img->createInfo.arrayLayers;
2086 }
2087
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002088 return extent;
2089}
2090
2091// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002092static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002093 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2094}
2095
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002096// Test if the extent argument has any dimensions set to 0.
2097static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2098 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2099}
2100
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002101// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002102VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2104 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002105 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002106 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002107 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002108 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002109 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002110 granularity.width *= block_size.width;
2111 granularity.height *= block_size.height;
2112 }
2113 }
2114 return granularity;
2115}
2116
2117// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2118static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2119 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002120 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2121 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002122 valid = false;
2123 }
2124 return valid;
2125}
2126
2127// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002128bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002129 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002130 bool skip = false;
2131 VkExtent3D offset_extent = {};
2132 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2133 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2134 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002135 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002136 // 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 -07002137 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002138 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Cort Stratton420ebd42018-05-04 01:12:23 -04002139 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002140 "%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 "
2141 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002142 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002143 }
2144 } else {
2145 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2146 // integer multiples of the image transfer granularity.
2147 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002148 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 -04002149 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002150 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2151 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002152 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2153 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002154 }
2155 }
2156 return skip;
2157}
2158
2159// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002160bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002161 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002162 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002163 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002164 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002165 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2166 // subresource extent.
2167 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002168 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 -04002169 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002170 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2171 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2172 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2173 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002174 }
2175 } else {
2176 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2177 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2178 // subresource extent dimensions.
2179 VkExtent3D offset_extent_sum = {};
2180 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2181 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2182 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002183 bool x_ok = true;
2184 bool y_ok = true;
2185 bool z_ok = true;
2186 switch (image_type) {
2187 case VK_IMAGE_TYPE_3D:
2188 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2189 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002190 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002191 case VK_IMAGE_TYPE_2D:
2192 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2193 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002194 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002195 case VK_IMAGE_TYPE_1D:
2196 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2197 (subresource_extent->width == offset_extent_sum.width));
2198 break;
2199 default:
2200 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2201 assert(false);
2202 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002203 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002204 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 -04002205 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002206 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2207 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2208 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2209 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2210 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2211 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002212 }
2213 }
2214 return skip;
2215}
2216
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002217bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002218 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002219 bool skip = false;
2220 if (mip_level >= img->createInfo.mipLevels) {
2221 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2222 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002223 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2224 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002225 }
2226 return skip;
2227}
2228
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002229bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002230 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002231 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002232 bool skip = false;
2233 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2234 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2235 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2236 HandleToUint64(cb_node->commandBuffer), vuid,
2237 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002238 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002239 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2240 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002241 }
2242 return skip;
2243}
2244
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002245// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002246bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002247 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002248 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002249 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002250 VkExtent3D granularity = GetScaledItg(cb_node, img);
2251 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002252 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002253 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002254 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002255 return skip;
2256}
2257
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002258// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002259bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002260 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002261 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002262 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002263 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002264 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2265 skip |=
2266 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002268 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002269 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2270 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002272 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002273 granularity = GetScaledItg(cb_node, dst_img);
2274 skip |=
2275 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002276 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002277 const VkExtent3D dest_effective_extent =
2278 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002280 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002281 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002282 return skip;
2283}
2284
Dave Houlton6f9059e2017-05-02 17:15:13 -06002285// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002286bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002287 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 bool skip = false;
2289
2290 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002291 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002292
2293 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002294 const VkExtent3D src_copy_extent = region.extent;
2295 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002296 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2297
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 bool slice_override = false;
2299 uint32_t depth_slices = 0;
2300
2301 // Special case for copying between a 1D/2D array and a 3D image
2302 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2303 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002304 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 slice_override = (depth_slices != 1);
2306 } 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 -07002307 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002308 slice_override = (depth_slices != 1);
2309 }
2310
2311 // Do all checks on source image
2312 //
2313 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002314 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2315 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 -06002316 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002317 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002318 "be 0 and 1, respectively.",
2319 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002320 }
2321 }
2322
Dave Houlton533be9f2018-03-26 17:08:30 -06002323 // VUID-VkImageCopy-srcImage-01785
2324 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2325 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 -06002326 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002327 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002328 "these must be 0 and 1, respectively.",
2329 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 }
2331
Dave Houlton533be9f2018-03-26 17:08:30 -06002332 // VUID-VkImageCopy-srcImage-01787
2333 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2334 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 -06002335 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002336 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2337 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002338 }
2339
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002340 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002342 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002343 skip |=
2344 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002345 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002347 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2348 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002349 }
2350 }
2351 } else { // Pre maint 1
2352 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002353 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002354 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 -06002355 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002356 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2357 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002358 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2359 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002360 }
2361 }
2362 }
2363
Dave Houltonc991cc92018-03-06 11:08:51 -07002364 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002365 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002366 if (FormatIsCompressed(src_state->createInfo.format) ||
2367 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002368 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002369 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002370 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2371 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2372 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002373 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 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 -07002375 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002376 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002378 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002379 }
2380
Dave Houlton94a00372017-12-14 15:08:47 -07002381 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002382 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2383 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002384 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002385 skip |=
2386 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002387 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002388 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002389 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002390 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002391 }
2392
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002393 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002394 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2395 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002396 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002397 skip |=
2398 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002399 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002400 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002401 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002402 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002405 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002406 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2407 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002408 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409 skip |=
2410 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002412 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002413 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002414 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002415 }
2416 } // Compressed
2417
2418 // Do all checks on dest image
2419 //
2420 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002421 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002422 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 -06002423 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002424 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002425 "these must be 0 and 1, respectively.",
2426 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002427 }
2428 }
2429
Dave Houlton533be9f2018-03-26 17:08:30 -06002430 // VUID-VkImageCopy-dstImage-01786
2431 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2432 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 -06002433 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002434 "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 -06002435 "and 1, respectively.",
2436 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002437 }
2438
2439 // VUID-VkImageCopy-dstImage-01788
2440 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2441 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002442 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002443 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2444 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002445 }
2446
2447 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002448 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002449 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 -06002450 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002451 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002452 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2453 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002454 }
2455 }
2456 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002457 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002459 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002460 skip |=
2461 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002462 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002463 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002464 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2465 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002466 }
2467 }
2468 } else { // Pre maint 1
2469 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002470 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002471 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 -06002472 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002473 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2474 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002475 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2476 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002477 }
2478 }
2479 }
2480
Dave Houltonc991cc92018-03-06 11:08:51 -07002481 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2482 if (FormatIsCompressed(dst_state->createInfo.format) ||
2483 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002484 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002485
2486 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002487 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2488 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2489 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002490 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002491 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 -07002492 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002493 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002494 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002495 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002496 }
2497
Dave Houlton94a00372017-12-14 15:08:47 -07002498 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002499 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2500 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002501 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002502 skip |=
2503 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002504 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002505 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002506 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002507 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002508 }
2509
Dave Houltonee281a52017-12-08 13:51:02 -07002510 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2511 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2512 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002513 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002514 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 -07002515 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002516 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2517 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002518 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002519 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520 }
2521
Dave Houltonee281a52017-12-08 13:51:02 -07002522 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2523 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2524 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002525 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002526 skip |=
2527 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002528 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002529 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002530 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002531 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002532 }
2533 } // Compressed
2534 }
2535 return skip;
2536}
2537
Dave Houltonc991cc92018-03-06 11:08:51 -07002538// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002539bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002540 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002541 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002542
2543 // Neither image is multiplane
2544 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2545 // If neither image is multi-plane the aspectMask member of src and dst must match
2546 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2547 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002548 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002549 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2550 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002551 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002552 }
2553 } else {
2554 // Source image multiplane checks
2555 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2556 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2557 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2558 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002559 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002560 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 -06002561 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002562 }
2563 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2564 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2565 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002566 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002567 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 -06002568 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002569 }
2570 // Single-plane to multi-plane
2571 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2572 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2573 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002574 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002575 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 -06002576 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002577 }
2578
2579 // Dest image multiplane checks
2580 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2581 aspect = region.dstSubresource.aspectMask;
2582 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2583 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002584 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002585 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 -06002586 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002587 }
2588 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2589 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2590 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002591 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002592 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 -06002593 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002594 }
2595 // Multi-plane to single-plane
2596 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2597 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2598 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002599 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002600 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 -06002601 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002602 }
2603 }
2604
2605 return skip;
2606}
2607
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002608bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2609 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002610 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002611 const auto *cb_node = GetCBState(commandBuffer);
2612 const auto *src_image_state = GetImageState(srcImage);
2613 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002614 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002615
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002616 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002617
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002618 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2619
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002620 for (uint32_t i = 0; i < regionCount; i++) {
2621 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002622
2623 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2624 VkExtent3D src_copy_extent = region.extent;
2625 VkExtent3D dst_copy_extent =
2626 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2627
Dave Houlton6f9059e2017-05-02 17:15:13 -06002628 bool slice_override = false;
2629 uint32_t depth_slices = 0;
2630
2631 // Special case for copying between a 1D/2D array and a 3D image
2632 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2633 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2634 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002635 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002636 slice_override = (depth_slices != 1);
2637 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2638 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002639 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002640 slice_override = (depth_slices != 1);
2641 }
2642
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002643 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2644 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2645 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002646 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002647 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002648 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002649 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002650 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2651 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002652 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002653 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2654 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002655
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002656 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002657 // No chance of mismatch if we're overriding depth slice count
2658 if (!slice_override) {
2659 // The number of depth slices in srcSubresource and dstSubresource must match
2660 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2661 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002662 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2663 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002664 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002665 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2666 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002667 if (src_slices != dst_slices) {
2668 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002669 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002670 << "] do not match";
2671 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 -06002672 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002673 }
2674 }
2675 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002676 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002677 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002678 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002679 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002680 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002681 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 -06002682 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002683 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002684 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002685
Dave Houltonc991cc92018-03-06 11:08:51 -07002686 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002687 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002688 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002689 }
2690
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002691 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002692 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2693 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002694 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002695 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 -06002696 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002697 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002698 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002699
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002700 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002701 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002702 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002703 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002704 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2705 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 -06002706 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002707 }
2708
2709 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002710 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002711 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002712 ss << "vkCmdCopyImage(): pRegion[" << i
2713 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002714 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 -06002715 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002716 }
2717
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002718 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2719 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2720 // 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 -07002721 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2722 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002723 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002724 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002725 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2726 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2727 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002728 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 -06002729 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002730 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002731
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002732 // 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 -07002733 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2734 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002735 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002736 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002737 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2738 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2739 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002740 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-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002742 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002743 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002744
Dave Houltonfc1a4052017-04-27 14:32:45 -06002745 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002746 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2747 if (slice_override) src_copy_extent.depth = depth_slices;
2748 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002749 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002750 skip |=
2751 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2752 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2753 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2754 "width [%1d].",
2755 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002756 }
2757
2758 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002759 skip |=
2760 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2761 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2762 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2763 "height [%1d].",
2764 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002765 }
2766 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002767 skip |=
2768 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2769 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2770 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2771 "depth [%1d].",
2772 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002773 }
2774
Dave Houltonee281a52017-12-08 13:51:02 -07002775 // Adjust dest extent if necessary
2776 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2777 if (slice_override) dst_copy_extent.depth = depth_slices;
2778
2779 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002780 if (extent_check & x_bit) {
2781 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 -06002782 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002783 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002784 "width [%1d].",
2785 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002786 }
2787 if (extent_check & y_bit) {
2788 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 -06002789 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002790 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002791 "height [%1d].",
2792 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002793 }
2794 if (extent_check & z_bit) {
2795 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 -06002796 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002797 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002798 "depth [%1d].",
2799 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002800 }
2801
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002802 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2803 // must not overlap in memory
2804 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002805 for (uint32_t j = 0; j < regionCount; j++) {
2806 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002807 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002808 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002809 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002810 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 -06002811 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002812 }
2813 }
2814 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002815 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002816
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002817 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2818 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2819 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002820 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002821 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2822 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002823 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 -06002824 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002825 }
2826 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002827 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002828 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2829 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 -06002830 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002831 }
2832 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002833
Dave Houlton33c22b72017-02-28 13:16:02 -07002834 // Source and dest image sample counts must match
2835 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2836 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2837 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 -06002838 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002839 }
2840
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002841 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2842 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002843 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002844 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2845 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2846 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2847 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002848 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002849 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2850 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2851 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2852 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002853 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002854 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002855 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002856 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2857 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002858 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002859 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2860 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2861 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2862 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2863 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2864 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002865 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002866 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002867 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2868 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002869 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002870 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2871 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002872 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2873 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002874 }
2875
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002876 return skip;
2877}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002878
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002879void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2880 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2881 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002882 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2883 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002884 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002885 auto src_image_state = GetImageState(srcImage);
2886 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002887
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002888 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002889 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002890 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2891 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002892 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002893}
2894
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002895// Returns true if sub_rect is entirely contained within rect
2896static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2897 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2898 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2899 return false;
2900 return true;
2901}
2902
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002903bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002904 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2905 const VkRect2D &render_area, uint32_t rect_count,
2906 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002907 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002908 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2909 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002910 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002911 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002912
2913 for (uint32_t j = 0; j < rect_count; j++) {
2914 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002915 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 -07002916 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2917 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2918 "the current render pass instance.",
2919 j);
2920 }
2921
2922 if (image_view_state) {
2923 // The layers specified by a given element of pRects must be contained within every attachment that
2924 // pAttachments refers to
2925 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2926 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2927 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2929 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2930 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2931 "of pAttachment[%d].",
2932 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002933 }
2934 }
2935 }
2936 return skip;
2937}
2938
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002939bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2940 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002941 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002942 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002943 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002944 if (!cb_node) return skip;
2945
2946 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2947 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2948 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002949 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002950
2951 // Validate that attachment is in reference list of active subpass
2952 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002953 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002954 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002955 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002956 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002957 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002958
John Zulauf3a548ef2019-02-01 16:14:07 -07002959 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2960 auto clear_desc = &pAttachments[attachment_index];
2961 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002962
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002963 if (0 == clear_desc->aspectMask) {
2964 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 -06002965 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002966 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2967 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 -06002968 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002969 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002970 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2971 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2972 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2973 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002974 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2975 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2976 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2977 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2978 attachment_index, clear_desc->colorAttachment,
2979 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2980 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2981 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002982
John Zulauff2582972019-02-09 14:53:30 -07002983 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2984 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002985 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002986 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2987 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002988 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002989 " subpass %u. colorAttachmentCount=%u",
2990 attachment_index, clear_desc->colorAttachment,
2991 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2992 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002993 }
John Zulauff2582972019-02-09 14:53:30 -07002994 fb_attachment = color_attachment;
2995
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002996 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2997 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2998 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002999 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07003000 skip |=
3001 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3002 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003003 }
3004 } else { // Must be depth and/or stencil
3005 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
3006 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003007 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003008 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 -07003009 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
3010 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003011 }
3012 if (!subpass_desc->pDepthStencilAttachment ||
3013 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
3014 skip |= log_msg(
3015 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003016 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07003017 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003018 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07003019 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003020 }
3021 }
John Zulauf3a548ef2019-02-01 16:14:07 -07003022 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003023 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3024 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06003025 }
3026 }
3027 }
3028 return skip;
3029}
3030
3031void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3032 const VkClearAttachment *pAttachments, uint32_t rectCount,
3033 const VkClearRect *pRects) {
3034 auto *cb_node = GetCBState(commandBuffer);
3035 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3036 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3037 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3038 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3039 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3040 const auto clear_desc = &pAttachments[attachment_index];
3041 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3042 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3043 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3044 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3045 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3046 subpass_desc->pDepthStencilAttachment) {
3047 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3048 }
3049 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003050 if (!clear_rect_copy) {
3051 // We need a copy of the clear rectangles that will persist until the last lambda executes
3052 // but we want to create it as lazily as possible
3053 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003054 }
John Zulauf441558b2019-08-12 11:47:39 -06003055 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3056 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003057 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003058 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003059 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003060 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003061 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3062 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003063 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3064 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003065 return skip;
3066 };
3067 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003068 }
3069 }
3070 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003071}
3072
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003073bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3074 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003075 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003076 const auto *cb_node = GetCBState(commandBuffer);
3077 const auto *src_image_state = GetImageState(srcImage);
3078 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003079
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003080 bool skip = false;
3081 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003082 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3083 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003084 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003085 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003086 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3087 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003088 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3089 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003090
Cort Stratton7df30962018-05-17 19:45:57 -07003091 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003092 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003093 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003094 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3095 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3096 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003097 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003098 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3099 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003100 // For each region, the number of layers in the image subresource should not be zero
3101 // For each region, src and dest image aspect must be color only
3102 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003103 skip |=
3104 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3105 skip |=
3106 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003107 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003108 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3109 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003110 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003111 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3112 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003113 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3114 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3115 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3116 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3117 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003118 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3119 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003120 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003121 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3122 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003123
3124 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003125 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3126 skip |= log_msg(
3127 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003128 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003129 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003130 }
Cort Stratton7df30962018-05-17 19:45:57 -07003131 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003132 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3133 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3134 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003135 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003136 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 -06003137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003138 }
3139 }
3140
3141 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3142 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003143 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 -06003144 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003145 }
3146 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3147 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003148 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 -06003149 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003150 }
3151 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3152 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3153 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 -06003154 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003155 }
3156 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3157 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3158 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 -06003159 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003160 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003161 } else {
3162 assert(0);
3163 }
3164 return skip;
3165}
3166
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003167bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3168 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003169 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003170 const auto *cb_node = GetCBState(commandBuffer);
3171 const auto *src_image_state = GetImageState(srcImage);
3172 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003173
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003174 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003175 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003176 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003177 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003178 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003179 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003180 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003181 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003182 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003183 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3184 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003185 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003186 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3187 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003188 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003189 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3190 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003191 skip |=
3192 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003193 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3194 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003195 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003196 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003197 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003198 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003199
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003200 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003201
Dave Houlton33c2d252017-06-09 17:08:32 -06003202 VkFormat src_format = src_image_state->createInfo.format;
3203 VkFormat dst_format = dst_image_state->createInfo.format;
3204 VkImageType src_type = src_image_state->createInfo.imageType;
3205 VkImageType dst_type = dst_image_state->createInfo.imageType;
3206
Cort Stratton186b1a22018-05-01 20:18:06 -04003207 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003208 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003209 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3210 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003211 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003212 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3213 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3214 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003215 }
3216
3217 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3218 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 -06003219 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003220 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003221 }
3222
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3224 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003226 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003227 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003228 }
3229
3230 // Validate consistency for unsigned formats
3231 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3232 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003233 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 << "the other one must also have unsigned integer format. "
3235 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3236 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 -06003237 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003238 }
3239
3240 // Validate consistency for signed formats
3241 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3242 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003243 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 << "the other one must also have signed integer format. "
3245 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3246 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 -06003247 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003248 }
3249
3250 // Validate filter for Depth/Stencil formats
3251 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3252 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003253 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003254 << "then filter must be VK_FILTER_NEAREST.";
3255 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 -06003256 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003257 }
3258
3259 // Validate aspect bits and formats for depth/stencil images
3260 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3261 if (src_format != dst_format) {
3262 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003263 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 << "stencil, the other one must have exactly the same format. "
3265 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3266 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003267 skip |=
3268 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3269 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003270 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003271 } // Depth or Stencil
3272
3273 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003274 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003275 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003276 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3277 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3278 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003279 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003280 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3281 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003282 for (uint32_t i = 0; i < regionCount; i++) {
3283 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003284 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003285 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003286 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3287 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003288 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003289 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3290 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003291 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3292 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3293 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003294 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003295 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003296 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003297 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003298 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3299 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003300 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003301 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3302 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003303 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003304 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3305 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003306 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003307 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003308 skip |=
3309 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3310 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003311 }
Dave Houlton48989f32017-05-26 15:01:46 -06003312 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3313 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003314 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003315 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003316 skip |=
3317 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3318 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003319 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003320
3321 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003322 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
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-layerCount-00239",
3326 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003327 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003328
Dave Houlton48989f32017-05-26 15:01:46 -06003329 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003330 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 -06003331 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003332 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003333 }
Dave Houlton48989f32017-05-26 15:01:46 -06003334
Dave Houlton33c2d252017-06-09 17:08:32 -06003335 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3336 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003337 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003338 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003339 "image format %s.",
3340 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003341 }
3342
3343 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3344 skip |= log_msg(
3345 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003346 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003347 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3348 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003349 }
3350
Dave Houlton48989f32017-05-26 15:01:46 -06003351 // Validate source image offsets
3352 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003353 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003354 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003355 skip |=
3356 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3357 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3358 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3359 "of (%1d, %1d). These must be (0, 1).",
3360 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003361 }
3362 }
3363
Dave Houlton33c2d252017-06-09 17:08:32 -06003364 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003365 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3366 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 -06003367 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003368 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003369 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3370 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003371 }
3372 }
3373
Dave Houlton33c2d252017-06-09 17:08:32 -06003374 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003375 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3376 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003377 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003378 skip |= log_msg(
3379 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3380 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3381 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3382 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003383 }
3384 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3385 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003386 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003387 skip |= log_msg(
3388 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003389 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003390 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003391 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003392 }
3393 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3394 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003395 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003396 skip |= log_msg(
3397 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3398 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3399 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3400 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003401 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003402 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003403 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 -06003404 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003405 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003406 }
Dave Houlton48989f32017-05-26 15:01:46 -06003407
3408 // Validate dest image offsets
3409 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003410 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003411 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003412 skip |=
3413 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3414 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3415 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3416 "(%1d, %1d). These must be (0, 1).",
3417 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003418 }
3419 }
3420
Dave Houlton33c2d252017-06-09 17:08:32 -06003421 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003422 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3423 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 -06003424 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003425 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003426 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3427 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003428 }
3429 }
3430
Dave Houlton33c2d252017-06-09 17:08:32 -06003431 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003432 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3433 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003434 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003435 skip |= log_msg(
3436 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3437 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3438 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3439 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003440 }
3441 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3442 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003443 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003444 skip |= log_msg(
3445 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003446 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003447 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003448 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003449 }
3450 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3451 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003452 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003453 skip |= log_msg(
3454 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3455 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3456 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3457 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003458 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003459 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003460 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 -06003461 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003462 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003463 }
3464
Dave Houlton33c2d252017-06-09 17:08:32 -06003465 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3466 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3467 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003468 skip |=
3469 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3470 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3471 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3472 "layerCount other than 1.",
3473 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003474 }
3475 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003476 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003477 } else {
3478 assert(0);
3479 }
3480 return skip;
3481}
3482
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003483void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3484 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3485 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003486 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3487 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003488 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003489 auto src_image_state = GetImageState(srcImage);
3490 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003491
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003492 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003493 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003494 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3495 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003496 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003497}
3498
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003499// 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 -06003500bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3501 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003502 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003503 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003504 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003505 // Iterate over the layout maps for each referenced image
3506 for (const auto &layout_map_entry : pCB->image_layout_map) {
3507 const auto image = layout_map_entry.first;
3508 const auto *image_state = GetImageState(image);
3509 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003510 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003511 ImageSubresourcePair isr_pair;
3512 isr_pair.image = image;
3513 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003514 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003515 for (const auto &pos : subres_map->InitialLayoutView()) {
3516 isr_pair.subresource = pos.subresource;
3517 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003518 VkImageLayout image_layout;
3519 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3520 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3521 // TODO: Set memory invalid which is in mem_tracker currently
3522 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003523 // Need to look up the inital layout *state* to get a bit more information
3524 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3525 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3526 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3527 if (!matches) {
3528 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003529 skip |= log_msg(
3530 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3531 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003532 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003533 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003534 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003535 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3536 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003537 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003538 }
3539 }
John Zulauff660ad62019-03-23 07:16:05 -06003540 }
3541
3542 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003543 for (const auto &pos : subres_map->CurrentLayoutView()) {
3544 VkImageLayout layout = pos.it->second;
3545 assert(layout != kInvalidLayout);
3546 isr_pair.subresource = pos.subresource;
3547 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003548 }
3549 }
John Zulauff660ad62019-03-23 07:16:05 -06003550
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003551 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003552}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003553
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003554void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003555 for (const auto &layout_map_entry : pCB->image_layout_map) {
3556 const auto image = layout_map_entry.first;
3557 const auto *image_state = GetImageState(image);
3558 if (!image_state) continue; // Can't set layouts of a dead image
3559 const auto &subres_map = layout_map_entry.second;
3560 ImageSubresourcePair isr_pair;
3561 isr_pair.image = image;
3562 isr_pair.hasSubresource = true;
3563
3564 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003565 for (const auto &pos : subres_map->CurrentLayoutView()) {
3566 VkImageLayout layout = pos.it->second;
3567 assert(layout != kInvalidLayout);
3568 isr_pair.subresource = pos.subresource;
3569 SetGlobalLayout(isr_pair, layout);
John Zulauff660ad62019-03-23 07:16:05 -06003570 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003571 }
3572}
3573
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003574// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003575// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3576// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003577bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3578 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003579 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003580 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003581 const char *vuid;
3582 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3583
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003584 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3585 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003586 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3587 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3588 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003589 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003590 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003591 "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
Shannon McPherson3ea65132018-12-05 10:37:39 -07003592 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3593 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3594 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3595 skip |=
3596 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3597 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003598 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003599 }
3600 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003601 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3602 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003603 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003604 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003605 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 -06003606 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003607 }
3608 }
3609
3610 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3611 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003612 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003613 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003614 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 -06003615 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003616 }
3617 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003618 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003619}
3620
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003621bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3622 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003623 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003624 const char *vuid;
3625 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003626
Jason Ekstranda1906302017-12-03 20:16:32 -08003627 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3628 VkFormat format = pCreateInfo->pAttachments[i].format;
3629 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3630 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3631 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003632 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 -06003633 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003634 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3635 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3636 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3637 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003638 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003639 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003640 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 -06003641 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003642 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3643 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3644 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3645 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003646 }
3647 }
3648 }
3649
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003650 // Track when we're observing the first use of an attachment
3651 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3652 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003653 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003654
3655 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3656 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3657 auto attach_index = subpass.pInputAttachments[j].attachment;
3658 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003659 switch (subpass.pInputAttachments[j].layout) {
3660 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3661 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3662 // These are ideal.
3663 break;
3664
3665 case VK_IMAGE_LAYOUT_GENERAL:
3666 // May not be optimal. TODO: reconsider this warning based on other constraints.
3667 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003668 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003669 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3670 break;
3671
Tobias Hectorbbb12282018-10-22 15:17:59 +01003672 case VK_IMAGE_LAYOUT_UNDEFINED:
3673 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003674 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3676 "Layout for input attachment reference %u in subpass %u is %s but must be "
3677 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003678 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003679 break;
3680
Piers Daniell9af77cd2019-10-16 13:54:12 -06003681 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3682 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3683 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3684 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003685 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003686 skip |= log_msg(
3687 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003688 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003689 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3690 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3691 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3692 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3693 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3694 skip |= log_msg(
3695 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003696 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003697 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3698 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3699 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3700 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3701 } else if ((subpass.pInputAttachments[j].aspectMask &
3702 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3703 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3704 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3705 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3706 const auto *attachment_reference_stencil_layout =
3707 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3708 if (attachment_reference_stencil_layout) {
3709 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3710 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3711 attachment_reference_stencil_layout->stencilLayout ==
3712 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3713 attachment_reference_stencil_layout->stencilLayout ==
3714 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3715 attachment_reference_stencil_layout->stencilLayout ==
3716 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3717 attachment_reference_stencil_layout->stencilLayout ==
3718 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3719 attachment_reference_stencil_layout->stencilLayout ==
3720 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3721 attachment_reference_stencil_layout->stencilLayout ==
3722 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3723 attachment_reference_stencil_layout->stencilLayout ==
3724 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3725 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3726 skip |=
3727 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003728 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003729 "In the attachment reference %u in subpass %u with pNext chain instance "
3730 "VkAttachmentReferenceStencilLayoutKHR"
3731 "the stencilLayout member but must not be "
3732 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3733 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3734 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3735 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3736 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3737 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3738 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3739 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3740 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3741 j, i);
3742 }
3743 } else {
3744 skip |=
3745 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003746 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003747 "When the layout for input attachment reference %u in subpass %u is "
3748 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3749 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3750 "VkAttachmentReferenceStencilLayout instance.",
3751 j, i);
3752 }
3753 }
3754 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3755 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3756 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3757 skip |= log_msg(
3758 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003759 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003760 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3761 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3762 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3763 j, i);
3764 }
3765 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3766 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3767 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3768 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003769 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003770 "When the aspectMask for input attachment reference %u in subpass %u is "
3771 "VK_IMAGE_ASPECT_STENCIL_BIT "
3772 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3773 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3774 j, i);
3775 }
3776 }
3777 break;
3778
Graeme Leese668a9862018-10-08 10:40:02 +01003779 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3780 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003781 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003782 break;
3783 } else {
3784 // Intentionally fall through to generic error message
3785 }
3786 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003787
Cort Stratton7547f772017-05-04 15:18:52 -07003788 default:
3789 // No other layouts are acceptable
3790 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 -06003791 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003792 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3793 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3794 }
3795
Cort Stratton7547f772017-05-04 15:18:52 -07003796 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003797 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3798 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003799
3800 bool used_as_depth =
3801 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3802 bool used_as_color = false;
3803 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3804 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3805 }
3806 if (!used_as_depth && !used_as_color &&
3807 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003808 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003809 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3810 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3811 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003812 }
3813 }
3814 attach_first_use[attach_index] = false;
3815 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003816
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003817 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3818 auto attach_index = subpass.pColorAttachments[j].attachment;
3819 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3820
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003821 // TODO: Need a way to validate shared presentable images here, currently just allowing
3822 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3823 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003824 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003825 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003826 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003827 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3828 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003829 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003830
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003831 case VK_IMAGE_LAYOUT_GENERAL:
3832 // May not be optimal; TODO: reconsider this warning based on other constraints?
3833 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003834 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003835 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3836 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003837
Tobias Hectorbbb12282018-10-22 15:17:59 +01003838 case VK_IMAGE_LAYOUT_UNDEFINED:
3839 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003840 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003841 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3842 "Layout for color attachment reference %u in subpass %u is %s but should be "
3843 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3844 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3845 break;
3846
Piers Daniell9af77cd2019-10-16 13:54:12 -06003847 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3848 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3849 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3850 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003851 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003852 skip |= log_msg(
3853 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003854 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003855 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3856 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3857 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3858 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3859 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3860 skip |= log_msg(
3861 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003862 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003863 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3864 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3865 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3866 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3867 } else if ((subpass.pColorAttachments[j].aspectMask &
3868 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3869 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3870 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3871 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3872 const auto *attachment_reference_stencil_layout =
3873 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3874 if (attachment_reference_stencil_layout) {
3875 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3876 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3877 attachment_reference_stencil_layout->stencilLayout ==
3878 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3879 attachment_reference_stencil_layout->stencilLayout ==
3880 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3881 attachment_reference_stencil_layout->stencilLayout ==
3882 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3883 attachment_reference_stencil_layout->stencilLayout ==
3884 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3885 attachment_reference_stencil_layout->stencilLayout ==
3886 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3887 attachment_reference_stencil_layout->stencilLayout ==
3888 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3889 attachment_reference_stencil_layout->stencilLayout ==
3890 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3891 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3892 skip |=
3893 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003894 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003895 "In the attachment reference %u in subpass %u with pNext chain instance "
3896 "VkAttachmentReferenceStencilLayoutKHR"
3897 "the stencilLayout member but must not be "
3898 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3899 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3900 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3901 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3902 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3903 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3904 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3905 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3906 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3907 j, i);
3908 }
3909 } else {
3910 skip |=
3911 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003912 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003913 "When the layout for color attachment reference %u in subpass %u is "
3914 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3915 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3916 "VkAttachmentReferenceStencilLayout instance.",
3917 j, i);
3918 }
3919 }
3920 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3921 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3922 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3923 skip |= log_msg(
3924 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003925 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003926 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3927 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3928 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3929 j, i);
3930 }
3931 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3932 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3933 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3934 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003935 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003936 "When the aspectMask for color attachment reference %u in subpass %u is "
3937 "VK_IMAGE_ASPECT_STENCIL_BIT "
3938 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3939 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3940 j, i);
3941 }
3942 }
3943 break;
3944
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003945 default:
3946 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 -06003947 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003948 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3949 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003950 }
3951
John Zulauf4eee2692019-02-09 16:14:25 -07003952 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3953 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3954 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003955 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003956 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 -07003957 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003958 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003959 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003960 }
3961
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003962 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003963 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3964 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003965 }
3966 attach_first_use[attach_index] = false;
3967 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003968
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003969 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3970 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003971 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3972 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3973 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003974 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003975
Dave Houltona9df0ce2018-02-07 10:51:23 -07003976 case VK_IMAGE_LAYOUT_GENERAL:
3977 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3978 // doing a bunch of transitions.
3979 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003980 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003981 "GENERAL layout for depth attachment may not give optimal performance.");
3982 break;
3983
Tobias Hectorbbb12282018-10-22 15:17:59 +01003984 case VK_IMAGE_LAYOUT_UNDEFINED:
3985 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003986 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003987 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3988 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3989 "layout or GENERAL.",
3990 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3991 break;
3992
Piers Daniell9af77cd2019-10-16 13:54:12 -06003993 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3994 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3995 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3996 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003997 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003998 skip |= log_msg(
3999 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004000 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004001 "Layout for depth attachment reference in subpass %u is %s but must not be "
4002 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4003 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4004 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4005 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4006 skip |= log_msg(
4007 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004008 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004009 "Layout for depth attachment reference in subpass %u is %s but must not be "
4010 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4011 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4012 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
4013 } else if ((subpass.pDepthStencilAttachment->aspectMask &
4014 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
4015 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
4016 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4017 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4018 const auto *attachment_reference_stencil_layout =
4019 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
4020 if (attachment_reference_stencil_layout) {
4021 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
4022 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
4023 attachment_reference_stencil_layout->stencilLayout ==
4024 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
4025 attachment_reference_stencil_layout->stencilLayout ==
4026 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4027 attachment_reference_stencil_layout->stencilLayout ==
4028 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
4029 attachment_reference_stencil_layout->stencilLayout ==
4030 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
4031 attachment_reference_stencil_layout->stencilLayout ==
4032 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
4033 attachment_reference_stencil_layout->stencilLayout ==
4034 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
4035 attachment_reference_stencil_layout->stencilLayout ==
4036 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
4037 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
4038 skip |=
4039 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004040 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004041 "In the attachment reference in subpass %u with pNext chain instance "
4042 "VkAttachmentReferenceStencilLayoutKHR"
4043 "the stencilLayout member but must not be "
4044 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4045 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4046 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4047 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4048 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4049 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4050 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4051 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4052 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4053 i);
4054 }
4055 } else {
4056 skip |=
4057 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004058 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004059 "When the layout for depth attachment reference in subpass %u is "
4060 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4061 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4062 "VkAttachmentReferenceStencilLayout instance.",
4063 i);
4064 }
4065 }
4066 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4067 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4068 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
4069 skip |= log_msg(
4070 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004071 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004072 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4073 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4074 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4075 i);
4076 }
4077 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4078 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4079 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4080 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004081 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004082 "When the aspectMask for depth attachment reference in subpass %u is "
4083 "VK_IMAGE_ASPECT_STENCIL_BIT "
4084 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4085 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4086 i);
4087 }
4088 }
4089 break;
4090
Dave Houltona9df0ce2018-02-07 10:51:23 -07004091 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4092 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004093 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004094 break;
4095 } else {
4096 // Intentionally fall through to generic error message
4097 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004098 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004099
Dave Houltona9df0ce2018-02-07 10:51:23 -07004100 default:
4101 // No other layouts are acceptable
4102 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 -06004103 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004104 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4105 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4106 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004107 }
4108
4109 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4110 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004111 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4112 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004113 }
4114 attach_first_use[attach_index] = false;
4115 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004116 }
4117 return skip;
4118}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004119
Mark Lobodzinski96210742017-02-09 10:33:46 -07004120// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4121// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06004122bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004123 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004124 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004125 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004126 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004127 if (strict) {
4128 correct_usage = ((actual & desired) == desired);
4129 } else {
4130 correct_usage = ((actual & desired) != 0);
4131 }
4132 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004133 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004134 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06004135 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
4136 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06004137 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4138 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004139 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06004140 skip =
4141 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 -06004142 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4143 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004144 }
4145 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004146 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004147}
4148
4149// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4150// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004151bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004152 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004153 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
4154 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004155}
4156
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004157bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004158 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004159 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004160 bool skip = false;
4161 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4162 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07004163 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4164 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004165 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07004166 format_properties.linearTilingFeatures, image_state->createInfo.format,
4167 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004168 }
4169 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4170 if ((format_properties.optimalTilingFeatures & desired) != desired) {
4171 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4172 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004173 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04004174 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07004175 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004176 }
4177 }
4178 return skip;
4179}
4180
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004181bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004182 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004183 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004184 // layerCount must not be zero
4185 if (subresource_layers->layerCount == 0) {
4186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4187 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
4188 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
4189 }
4190 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4191 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
4192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4193 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
4194 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
4195 }
4196 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4197 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4198 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4199 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4200 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
4201 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4202 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4203 func_name, i, member);
4204 }
4205 return skip;
4206}
4207
Mark Lobodzinski96210742017-02-09 10:33:46 -07004208// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4209// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004210bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004211 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004212 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
4213 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004214}
4215
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004216bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004217 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004218 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004219
4220 const VkDeviceSize &range = pCreateInfo->range;
4221 if (range != VK_WHOLE_SIZE) {
4222 // Range must be greater than 0
4223 if (range <= 0) {
4224 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4225 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
4226 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4227 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4228 range);
4229 }
4230 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004231 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4232 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004233 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4234 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
4235 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4236 ") 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 +02004237 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004238 range, format_size);
4239 }
4240 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004241 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
4242 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4243 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
4244 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4245 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4246 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4247 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004248 }
4249 // The sum of range and offset must be less than or equal to the size of buffer
4250 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
4251 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4252 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
4253 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4254 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4255 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4256 range, pCreateInfo->offset, buffer_state->createInfo.size);
4257 }
4258 }
4259 return skip;
4260}
4261
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004262bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004263 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004264 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004265 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4266 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
4267 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4268 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
4269 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4270 "be supported for uniform texel buffers");
4271 }
4272 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4273 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
4274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4275 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
4276 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4277 "be supported for storage texel buffers");
4278 }
4279 return skip;
4280}
4281
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004282bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004283 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004284 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004285
Dave Houltond8ed0212018-05-16 17:18:24 -06004286 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004287
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004288 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004289 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 -06004290 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004291 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004292 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004293 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004294
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004295 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004296 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 -06004297 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004298 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004299 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004300 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004301
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004302 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004303 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 -06004304 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004305 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004306 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004307 }
Jeff Bolz87697532019-01-11 22:54:00 -06004308
4309 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4310 if (chained_devaddr_struct) {
4311 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4312 chained_devaddr_struct->deviceAddress != 0) {
4313 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4314 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4315 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4316 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4317 }
4318 }
4319
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004320 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4321 if (chained_opaqueaddr_struct) {
4322 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4323 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
4324 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4325 "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4326 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4327 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
4328 }
4329 }
4330
Shannon McPherson4984e642019-12-05 13:04:34 -07004331 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004332 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004333 skip |= log_msg(
4334 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPherson4984e642019-12-05 13:04:34 -07004335 "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004336 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4337 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4338 }
4339
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004340 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004341 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4342 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4343 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004344 }
4345
Mark Lobodzinski96210742017-02-09 10:33:46 -07004346 return skip;
4347}
4348
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004349bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004350 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004351 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004352 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004353 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4354 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004355 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004356 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4357 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004358 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004359 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4360 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4361 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004362
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004363 // Buffer view offset must be less than the size of buffer
4364 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4366 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4367 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4368 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4369 pCreateInfo->offset, buffer_state->createInfo.size);
4370 }
4371
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004372 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004373 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4374 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4375 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4376 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4377 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4378 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4379 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4380 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4381 }
4382
4383 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4384 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4385 if ((elementSize % 3) == 0) {
4386 elementSize /= 3;
4387 }
4388 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4389 VkDeviceSize alignmentRequirement =
4390 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4391 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4392 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4393 }
4394 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4395 skip |= log_msg(
4396 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4397 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4398 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4399 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4400 ") must be a multiple of the lesser of "
4401 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4402 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4403 "(%" PRId32
4404 ") is VK_TRUE, the size of a texel of the requested format. "
4405 "If the size of a texel is a multiple of three bytes, then the size of a "
4406 "single component of format is used instead",
4407 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4408 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4409 }
4410 }
4411 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4412 VkDeviceSize alignmentRequirement =
4413 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4414 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4415 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4416 }
4417 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4418 skip |= log_msg(
4419 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4420 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4421 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4422 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4423 ") must be a multiple of the lesser of "
4424 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4425 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4426 "(%" PRId32
4427 ") is VK_TRUE, the size of a texel of the requested format. "
4428 "If the size of a texel is a multiple of three bytes, then the size of a "
4429 "single component of format is used instead",
4430 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4431 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4432 }
4433 }
4434 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004435
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004436 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004437
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004438 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004439 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004440 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004441}
4442
Mark Lobodzinski602de982017-02-09 11:01:33 -07004443// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004444bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004445 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004446 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004447 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4448 if (image != VK_NULL_HANDLE) {
4449 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4450 }
4451
Dave Houlton1d2022c2017-03-29 11:43:58 -06004452 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004453 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004454 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004455 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004456 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004458 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004459 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004460 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004461 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004462 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004463 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004464 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4465 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004466 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004467 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004468 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004469 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4470 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004471 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004472 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004473 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004474 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004475 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004476 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004477 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004478 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004479 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004480 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004481 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004482 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004483 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004484 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004485 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004486 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004487 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004488 } else if (FormatIsMultiplane(format)) {
4489 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4490 if (3 == FormatPlaneCount(format)) {
4491 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4492 }
4493 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004494 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004495 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4496 "set, where n = [0, 1, 2].",
4497 func_name);
4498 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004499 }
4500 return skip;
4501}
4502
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004503bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4504 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4505 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004506 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004507 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004508
4509 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004510 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004511 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 -06004512 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004513 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004514 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4515 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004516 }
Petr Kraus4d718682017-05-18 03:38:41 +02004517
Petr Krausffa94af2017-08-08 21:46:02 +02004518 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4519 if (subresourceRange.levelCount == 0) {
4520 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 -06004521 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004522 } else {
4523 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004524
Petr Krausffa94af2017-08-08 21:46:02 +02004525 if (necessary_mip_count > image_mip_count) {
4526 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 -06004527 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004528 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004529 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004530 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004531 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004532 }
Petr Kraus4d718682017-05-18 03:38:41 +02004533 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004534 }
Petr Kraus4d718682017-05-18 03:38:41 +02004535
4536 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004537 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004538 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 -06004539 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004540 "%s: %s.baseArrayLayer (= %" PRIu32
4541 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4542 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004543 }
Petr Kraus4d718682017-05-18 03:38:41 +02004544
Petr Krausffa94af2017-08-08 21:46:02 +02004545 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4546 if (subresourceRange.layerCount == 0) {
4547 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 -06004548 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004549 } else {
4550 const uint64_t necessary_layer_count =
4551 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004552
Petr Krausffa94af2017-08-08 21:46:02 +02004553 if (necessary_layer_count > image_layer_count) {
4554 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 -06004555 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004556 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004557 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004558 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004559 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004560 }
Petr Kraus4d718682017-05-18 03:38:41 +02004561 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004562 }
Petr Kraus4d718682017-05-18 03:38:41 +02004563
Mark Lobodzinski602de982017-02-09 11:01:33 -07004564 return skip;
4565}
4566
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004567bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004568 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004569 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004570 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4571 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4572 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4573
4574 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4575 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4576
4577 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004578 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4579 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004580 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004581 : "VUID-VkImageViewCreateInfo-image-01482")
4582 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4583 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004584 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004585 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4586 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004587
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004588 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004589 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4590 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4591}
4592
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004593bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004594 const VkImageSubresourceRange &subresourceRange,
4595 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004596 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004597 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4598 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4599 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4600 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004601
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004602 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4603 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4604 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004605}
4606
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004607bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004608 const VkImageSubresourceRange &subresourceRange,
4609 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004610 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004611 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4612 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4613 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4614 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004615
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004616 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4617 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004618 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4619}
4620
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004621bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004622 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004623 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004624 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004625 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4626 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4627 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4628 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004629
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004630 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4631 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004632 subresourceRangeErrorCodes);
4633}
4634
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004635bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004636 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004637 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004638 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004639 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004640 skip |=
4641 ValidateImageUsageFlags(image_state,
4642 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4643 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4644 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4645 false, kVUIDUndefined, "vkCreateImageView()",
4646 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4647 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004648 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004649 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004650 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004651 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004652 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004653 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004654
4655 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4656 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004657 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4658 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004659 VkFormat view_format = pCreateInfo->format;
4660 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004661 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004662 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004663
Dave Houltonbd2e2622018-04-10 16:41:14 -06004664 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004665 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004666 if (chained_ivuci_struct) {
Andrew Fobel3abeb992020-01-20 16:33:22 -05004667 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance2) {
4668 if (!device_extensions.vk_ext_separate_stencil_usage) {
4669 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
4670 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4671 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02661",
4672 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, usage must not "
4673 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4674 }
4675 } else {
4676 const auto image_stencil_struct =
4677 lvl_find_in_chain<VkImageStencilUsageCreateInfoEXT>(image_state->createInfo.pNext);
4678 if (image_stencil_struct == nullptr) {
4679 if ((image_usage | chained_ivuci_struct->usage) != image_usage) {
4680 skip |= log_msg(
4681 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
4682 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02662",
4683 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo and image was not created "
4684 "with a VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, usage must not include "
4685 "any bits that were not set in VkImageCreateInfo::usage used to create image");
4686 }
4687 } else {
4688 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) == VK_IMAGE_ASPECT_STENCIL_BIT &&
4689 (image_stencil_struct->stencilUsage | chained_ivuci_struct->usage) !=
4690 image_stencil_struct->stencilUsage) {
4691 skip |= log_msg(
4692 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
4693 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02663",
4694 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4695 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4696 "includes VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not include any "
4697 "bits that were not set in VkImageStencilUsageCreateInfo::stencilUsage used to create image");
4698 }
4699 if ((aspect_mask & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0 &&
4700 (image_usage | chained_ivuci_struct->usage) != image_usage) {
4701 skip |= log_msg(
4702 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
4703 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-pNext-02664",
4704 "vkCreateImageView(): pNext chain includes VkImageViewUsageCreateInfo, image was created with a "
4705 "VkImageStencilUsageCreateInfo in pNext of vkImageCreateInfo, and subResourceRange.aspectMask "
4706 "includes bits other than VK_IMAGE_ASPECT_STENCIL_BIT, VkImageViewUsageCreateInfo::usage must not "
4707 "include any bits that were not set in VkImageCreateInfo::usage used to create image");
4708 }
4709 }
4710 }
4711 }
4712
Dave Houltonbd2e2622018-04-10 16:41:14 -06004713 image_usage = chained_ivuci_struct->usage;
4714 }
4715
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004716 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4717 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004718 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004719 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004720 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004721 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004722 std::stringstream ss;
4723 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004724 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004725 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004726 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 -07004727 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004728 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004729 }
4730 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004731 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004732 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4733 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4734 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4735 std::stringstream ss;
4736 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004737 << " is not in the same format compatibility class as "
4738 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004739 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4740 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004741 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 -07004742 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004743 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004744 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004745 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004746 }
4747 } else {
4748 // Format MUST be IDENTICAL to the format the image was created with
4749 if (image_format != view_format) {
4750 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004751 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004752 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004753 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004754 skip |=
4755 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004756 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004757 }
4758 }
4759
4760 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004761 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004762
4763 switch (image_type) {
4764 case VK_IMAGE_TYPE_1D:
4765 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004767 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004768 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4769 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004770 }
4771 break;
4772 case VK_IMAGE_TYPE_2D:
4773 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4774 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4775 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004776 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 -07004777 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004778 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4779 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004780 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004781 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 -07004782 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004783 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4784 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004785 }
4786 }
4787 break;
4788 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004789 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004790 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4791 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4792 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004793 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004794 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004795 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004796 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4797 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004798 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4799 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004800 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004801 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004802 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004803 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4804 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004805 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4806 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004807 }
4808 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004809 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 -07004810 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004811 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4812 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004813 }
4814 }
4815 } else {
4816 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004817 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 -07004818 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004819 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4820 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004821 }
4822 }
4823 break;
4824 default:
4825 break;
4826 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004827
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004828 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004829 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004830 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004831 }
4832
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004833 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004834 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4835 : format_properties.optimalTilingFeatures;
4836
4837 if (tiling_features == 0) {
4838 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 -07004839 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004840 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4841 "physical device.",
4842 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4843 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4844 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 -07004845 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004846 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4847 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4848 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4849 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4850 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 -07004851 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004852 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4853 "VK_IMAGE_USAGE_STORAGE_BIT.",
4854 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4855 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4856 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4857 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 -07004858 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004859 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4860 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4861 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4862 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4863 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4864 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 -07004865 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004866 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4867 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4868 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004869 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004870
Jeff Bolz9af91c52018-09-01 21:53:57 -05004871 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4872 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4873 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 -07004874 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004875 "vkCreateImageView() If image was created with usage containing "
4876 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4877 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4878 }
4879 if (view_format != VK_FORMAT_R8_UINT) {
4880 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 -07004881 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004882 "vkCreateImageView() If image was created with usage containing "
4883 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4884 }
4885 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004886 }
4887 return skip;
4888}
4889
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004890static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4891 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4892 const VkBufferCopy *pRegions) {
4893 bool skip = false;
4894
4895 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4896 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4897 VkDeviceSize src_min = UINT64_MAX;
4898 VkDeviceSize src_max = 0;
4899 VkDeviceSize dst_min = UINT64_MAX;
4900 VkDeviceSize dst_max = 0;
4901
4902 for (uint32_t i = 0; i < regionCount; i++) {
4903 src_min = std::min(src_min, pRegions[i].srcOffset);
4904 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4905 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4906 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4907
4908 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4909 if (pRegions[i].srcOffset >= src_buffer_size) {
4910 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4911 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4912 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4913 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4914 i, pRegions[i].srcOffset, i, pRegions[i].size);
4915 }
4916
4917 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4918 if (pRegions[i].dstOffset >= dst_buffer_size) {
4919 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4920 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4921 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4922 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4923 i, pRegions[i].dstOffset, i, pRegions[i].size);
4924 }
4925
4926 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4927 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4929 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4930 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4931 ") is greater than the source buffer size (%" PRIuLEAST64
4932 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4933 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4934 }
4935
4936 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4937 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4938 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4939 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4940 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4941 ") is greater than the destination buffer size (%" PRIuLEAST64
4942 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4943 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4944 }
4945 }
4946
4947 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4948 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4949 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4950 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4951 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4952 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4953 }
4954 }
4955
4956 return skip;
4957}
4958
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004959bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004960 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004961 const auto cb_node = GetCBState(commandBuffer);
4962 const auto src_buffer_state = GetBufferState(srcBuffer);
4963 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004964
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004965 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004966 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4967 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004968 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004969 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004970 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4971 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004972 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004973 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4974 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004975 skip |=
4976 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4977 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004978 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4979 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004980 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004981 return skip;
4982}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004983
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004984bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004985 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004986 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004987 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004988 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 -06004989 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004990 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004991 } else {
4992 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004993 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 -06004994 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004995 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004996 }
4997 }
4998 return skip;
4999}
5000
Jeff Bolz5c801d12019-10-09 10:38:45 -05005001bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
5002 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005003 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06005004 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005005
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005006 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07005007 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005008 skip |=
5009 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005010 }
5011 return skip;
5012}
5013
Jeff Bolz5c801d12019-10-09 10:38:45 -05005014bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005015 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005016
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005017 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005018 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07005019 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005020 }
5021 return skip;
5022}
5023
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005024bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005025 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07005026 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06005027 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005028 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07005029 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07005030 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06005031 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07005032 }
5033 return skip;
5034}
5035
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005036bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005037 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005038 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005039 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005040 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005041 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07005042 skip |=
5043 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
5044 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005045 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005046 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005047 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
5048 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005049 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07005050
5051 if (dstOffset >= buffer_state->createInfo.size) {
5052 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
5053 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-dstOffset-00024",
5054 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
5055 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
5056 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
5057 }
5058
5059 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
5060 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
5061 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-size-00027",
5062 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
5063 ") minus dstOffset (0x%" PRIxLEAST64 ").",
5064 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
5065 }
5066
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07005067 return skip;
5068}
5069
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005070bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
5071 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005072 bool skip = false;
5073
5074 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005075 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
5076 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005077 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 -06005078 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07005079 "%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 -06005080 "and 1, respectively.",
5081 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005082 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005083 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005084
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005085 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5086 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005087 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 -06005088 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005089 "%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 -06005090 "must be 0 and 1, respectively.",
5091 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005092 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005093 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005094
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005095 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5096 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005097 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 -06005098 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005099 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5100 "For 3D images these must be 0 and 1, respectively.",
5101 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005102 }
5103 }
5104
5105 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005106 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005107 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5108
Dave Houltona585d132019-01-18 13:05:42 -07005109 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005110 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 -06005111 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005112 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005113 " must be a multiple of this format's texel size (%" PRIu32 ").",
5114 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005115 }
5116
5117 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005118 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005119 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 -06005120 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005121 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5122 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005123 }
5124
5125 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5126 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005127 skip |=
5128 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005129 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005130 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5131 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005132 }
5133
5134 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5135 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
5136 skip |= log_msg(
5137 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005138 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005139 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5140 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005141 }
5142
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005143 // Calculate adjusted image extent, accounting for multiplane image factors
5144 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
5145 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
5146 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
5147 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
5148 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5149 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
5150 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5151 "zero or <= image subresource width (%d).",
5152 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
5153 adusted_image_extent.width);
5154 }
5155
5156 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
5157 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
5158 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
5159 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5160 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
5161 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5162 "zero or <= image subresource height (%d).",
5163 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
5164 adusted_image_extent.height);
5165 }
5166
5167 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
5168 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
5169 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
5170 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5171 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
5172 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5173 "zero or <= image subresource depth (%d).",
5174 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
5175 adusted_image_extent.depth);
5176 }
5177
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005178 // subresource aspectMask must have exactly 1 bit set
5179 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5180 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5181 if (aspect_mask_bits.count() != 1) {
5182 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 -06005183 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005184 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005185 }
5186
5187 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005188 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005189 skip |= log_msg(
5190 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005191 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005192 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5193 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005194 }
5195
5196 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005197 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005198 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005199
5200 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005201 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005202 skip |= log_msg(
5203 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005204 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005205 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5206 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005207 }
5208
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005209 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005210 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07005211 skip |= log_msg(
5212 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005213 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005214 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5215 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005216 }
5217
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005218 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005219 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5220 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5221 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005222 skip |=
5223 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005224 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005225 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5226 "width & height (%d, %d)..",
5227 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005228 }
5229
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005230 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005231 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005232 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005233 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 -06005234 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005235 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005236 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005237 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005238 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005239
5240 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005241 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005242 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005243 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
5244 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 -06005245 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07005246 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005247 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005248 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005249 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005250 }
5251
5252 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005253 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005254 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
5255 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 -06005256 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07005257 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005258 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005259 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005260 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005261 }
5262
5263 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005264 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005265 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
5266 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 -06005267 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005268 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005269 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005270 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005271 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005272 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005273 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005274
5275 // Checks that apply only to multi-planar format images
5276 if (FormatIsMultiplane(image_state->createInfo.format)) {
5277 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5278 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5279 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5280 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5281 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5282 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5283 "format has three planes.",
5284 function, i);
5285 }
5286
5287 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5288 if (0 == (pRegions[i].imageSubresource.aspectMask &
5289 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
5290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5291 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5292 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5293 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5294 function, i);
5295 }
5296 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005297 }
5298
5299 return skip;
5300}
5301
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005302static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005303 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005304 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005305 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005306
5307 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005308 VkExtent3D extent = pRegions[i].imageExtent;
5309 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005310
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005311 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5312 {
Dave Houlton51653902018-06-22 17:32:13 -06005313 skip |=
5314 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5315 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5316 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005317 }
5318
5319 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5320
5321 // 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 -06005322 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005323 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005324 if (image_extent.width % block_extent.width) {
5325 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5326 }
5327 if (image_extent.height % block_extent.height) {
5328 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5329 }
5330 if (image_extent.depth % block_extent.depth) {
5331 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5332 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005333 }
5334
Dave Houltonfc1a4052017-04-27 14:32:45 -06005335 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005336 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 -06005337 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005338 }
5339 }
5340
5341 return skip;
5342}
5343
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005344static inline bool ValidateBufferBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state,
5345 const BUFFER_STATE *buff_state, uint32_t regionCount, const VkBufferImageCopy *pRegions,
5346 const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005347 bool skip = false;
5348
5349 VkDeviceSize buffer_size = buff_state->createInfo.size;
5350
5351 for (uint32_t i = 0; i < regionCount; i++) {
5352 VkExtent3D copy_extent = pRegions[i].imageExtent;
5353
5354 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5355 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005356 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5357 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005358
Tom Cooperb2550c72018-10-15 13:08:41 +01005359 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005360 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005361 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005362 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5363 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5364
5365 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5366 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5367 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005368 }
5369
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005370 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5371 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5372 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005373 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005374 } else {
5375 // Calculate buffer offset of final copied byte, + 1.
5376 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5377 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5378 max_buffer_offset *= unit_size; // convert to bytes
5379 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005380
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005381 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005382 skip |=
5383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5384 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005385 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005386 }
5387 }
5388
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005389 return skip;
5390}
5391
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005392bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005393 VkBuffer dstBuffer, uint32_t regionCount,
5394 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005395 const auto cb_node = GetCBState(commandBuffer);
5396 const auto src_image_state = GetImageState(srcImage);
5397 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005398
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005399 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005400
5401 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005402 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005403
5404 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005405 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005406
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005407 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005408
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005409 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5410 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 -06005411 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005412 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005413 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005414 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005415 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005416 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005417 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005418 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005419
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005420 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005421 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005422 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5423 skip |=
5424 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005425
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005426 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005427 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005428 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5429 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005430 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005431 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5432 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005433 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005434 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5435 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005436 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005437 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005438 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005439 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005440 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5441 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5442 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005443 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005444 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005445 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005446 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005447 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5448 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005449 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5450 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5451 skip |=
5452 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5453 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5454 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005455 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5456 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005457 }
5458 return skip;
5459}
5460
John Zulauf1686f232019-07-09 16:27:11 -06005461void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5462 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5463 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5464
5465 auto cb_node = GetCBState(commandBuffer);
5466 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005467 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005468 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005469 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005470 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005471}
5472
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005473bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5474 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005475 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005476 const auto cb_node = GetCBState(commandBuffer);
5477 const auto src_buffer_state = GetBufferState(srcBuffer);
5478 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005479
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005480 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005481
5482 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005483 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005484
5485 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005486 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005487 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005488 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5489 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 -06005490 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005491 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005492 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005493 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005494 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005495 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005496 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005497 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005498 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005499 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005500 skip |=
5501 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5502 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005503 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005504 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5505 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005506 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005507 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5508 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005509 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005510 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5511 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005512 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005513 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005514 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005515 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005516 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5517 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5518 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005519 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005520 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005521 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005522 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005523 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5524 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005525 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5526 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5527 skip |=
5528 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5529 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5530 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005531 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5532 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005533 }
5534 return skip;
5535}
5536
John Zulauf1686f232019-07-09 16:27:11 -06005537void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5538 VkImageLayout dstImageLayout, uint32_t regionCount,
5539 const VkBufferImageCopy *pRegions) {
5540 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5541
5542 auto cb_node = GetCBState(commandBuffer);
5543 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005544 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005545 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005546 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005547 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005548}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005549
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005550bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005551 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005552 bool skip = false;
5553 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5554
Dave Houlton1d960ff2018-01-19 12:17:05 -07005555 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005556 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5557 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5558 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005559 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 -06005560 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005561 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005562 }
5563
John Zulaufa26d3c82019-08-14 16:09:08 -06005564 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005565 if (!image_entry) {
5566 return skip;
5567 }
5568
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005569 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5570 if (device_extensions.vk_ext_image_drm_format_modifier) {
5571 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5572 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5573 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5574 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5575 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5576 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5577 }
5578 } else {
5579 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5580 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5581 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5582 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5583 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005584 }
5585
Dave Houlton1d960ff2018-01-19 12:17:05 -07005586 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005587 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005588 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5589 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5590 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5591 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005592 }
5593
Dave Houlton1d960ff2018-01-19 12:17:05 -07005594 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005595 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005596 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5597 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5598 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5599 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005600 }
5601
Dave Houlton1d960ff2018-01-19 12:17:05 -07005602 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005603 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005604 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5605 if (FormatIsMultiplane(img_format)) {
5606 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5607 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5608 if (FormatPlaneCount(img_format) > 2u) {
5609 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5610 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5611 }
5612 if (sub_aspect != (sub_aspect & allowed_flags)) {
5613 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5614 HandleToUint64(image), vuid,
5615 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5616 ") must be a single-plane specifier flag.",
5617 sub_aspect);
5618 }
5619 } else if (FormatIsColor(img_format)) {
5620 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5621 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5622 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5623 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5624 "VK_IMAGE_ASPECT_COLOR.");
5625 }
5626 } else if (FormatIsDepthOrStencil(img_format)) {
5627 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5628 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005629 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005630 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5631 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5632 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5633 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005634 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 -06005635 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5636 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5637 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005638 }
5639 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005640
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005641 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005642 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005643 }
5644
Mike Weiblen672b58b2017-02-21 14:32:53 -07005645 return skip;
5646}