blob: 02dc95717acfc94f882fab4784162c5b293745f8 [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");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001877 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001878 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001879 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001880 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001881 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001882 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1883 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001884 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001885 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1886 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001887 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 -06001888 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001889 }
1890 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001891 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001892 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001893 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 -06001894 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001895 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001896 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1897 char const str[] =
1898 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1899 "set.";
1900 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 -06001901 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001902 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001903 }
1904 return skip;
1905}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001906
John Zulaufeabb4462019-07-05 14:13:03 -06001907void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1908 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1909 const VkImageSubresourceRange *pRanges) {
1910 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1911 auto cb_node = GetCBState(commandBuffer);
1912 auto image_state = GetImageState(image);
1913 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001914 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001915 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001916 }
1917 }
1918}
1919
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001920// Returns true if [x, xoffset] and [y, yoffset] overlap
1921static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1922 bool result = false;
1923 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1924 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1925
1926 if (intersection_max > intersection_min) {
1927 result = true;
1928 }
1929 return result;
1930}
1931
Dave Houltonc991cc92018-03-06 11:08:51 -07001932// Returns true if source area of first copy region intersects dest area of second region
1933// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1934static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001935 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001936
Dave Houltonc991cc92018-03-06 11:08:51 -07001937 // Separate planes within a multiplane image cannot intersect
1938 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001939 return result;
1940 }
1941
Dave Houltonc991cc92018-03-06 11:08:51 -07001942 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1943 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1944 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001945 result = true;
1946 switch (type) {
1947 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001948 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001949 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001950 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001951 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001952 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001953 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001954 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001955 break;
1956 default:
1957 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1958 assert(false);
1959 }
1960 }
1961 return result;
1962}
1963
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964// Returns non-zero if offset and extent exceed image extents
1965static const uint32_t x_bit = 1;
1966static const uint32_t y_bit = 2;
1967static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001968static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001969 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001970 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001971 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1972 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001973 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001974 }
1975 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1976 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001977 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001978 }
1979 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1980 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001981 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001982 }
1983 return result;
1984}
1985
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001986// Test if two VkExtent3D structs are equivalent
1987static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1988 bool result = true;
1989 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1990 (extent->depth != other_extent->depth)) {
1991 result = false;
1992 }
1993 return result;
1994}
1995
Dave Houltonee281a52017-12-08 13:51:02 -07001996// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1997// Destination image texel extents must be adjusted by block size for the dest validation checks
1998VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1999 VkExtent3D adjusted_extent = extent;
unknown948b6ba2019-09-19 17:32:54 -06002000 if ((FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2001 !(FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002002 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002003 adjusted_extent.width /= block_size.width;
2004 adjusted_extent.height /= block_size.height;
2005 adjusted_extent.depth /= block_size.depth;
unknown948b6ba2019-09-19 17:32:54 -06002006 } else if (!(FormatIsCompressed(src_format) || FormatIsSinglePlane_422(src_format)) &&
2007 (FormatIsCompressed(dst_format) || FormatIsSinglePlane_422(dst_format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002008 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07002009 adjusted_extent.width *= block_size.width;
2010 adjusted_extent.height *= block_size.height;
2011 adjusted_extent.depth *= block_size.depth;
2012 }
2013 return adjusted_extent;
2014}
2015
Dave Houlton6f9059e2017-05-02 17:15:13 -06002016// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2018 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002019
2020 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002021 if (mip >= img->createInfo.mipLevels) {
2022 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002023 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002024
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002025 // 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 -06002026 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002027
Dave Houltone48cd112019-01-03 17:01:18 -07002028 // If multi-plane, adjust per-plane extent
2029 if (FormatIsMultiplane(img->createInfo.format)) {
2030 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2031 extent.width /= divisors.width;
2032 extent.height /= divisors.height;
2033 }
2034
Jeff Bolzef40fec2018-09-01 22:04:34 -05002035 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2036 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002037 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002038 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2039 } else {
2040 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2041 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2042 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2043 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002044
Dave Houlton6f9059e2017-05-02 17:15:13 -06002045 // Image arrays have an effective z extent that isn't diminished by mip level
2046 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002047 extent.depth = img->createInfo.arrayLayers;
2048 }
2049
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002050 return extent;
2051}
2052
2053// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002054static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2056}
2057
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002058// Test if the extent argument has any dimensions set to 0.
2059static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2060 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2061}
2062
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002064VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002065 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2066 VkExtent3D granularity = {0, 0, 0};
Jeff Bolz6835fda2019-10-06 00:15:34 -05002067 auto pPool = cb_node->command_pool.get();
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002068 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002069 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
unknown948b6ba2019-09-19 17:32:54 -06002070 if (FormatIsCompressed(img->createInfo.format) || FormatIsSinglePlane_422(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002071 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002072 granularity.width *= block_size.width;
2073 granularity.height *= block_size.height;
2074 }
2075 }
2076 return granularity;
2077}
2078
2079// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2080static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2081 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002082 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2083 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002084 valid = false;
2085 }
2086 return valid;
2087}
2088
2089// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002090bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002091 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002092 bool skip = false;
2093 VkExtent3D offset_extent = {};
2094 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2095 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2096 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002097 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002098 // 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 -07002099 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002100 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 -04002101 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002102 "%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 "
2103 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002104 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002105 }
2106 } else {
2107 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2108 // integer multiples of the image transfer granularity.
2109 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002110 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 -04002111 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002112 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2113 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002114 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2115 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002116 }
2117 }
2118 return skip;
2119}
2120
2121// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002122bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002123 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002124 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002125 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002126 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002127 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2128 // subresource extent.
2129 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002130 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 -04002131 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002132 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2133 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2134 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2135 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002136 }
2137 } else {
2138 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2139 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2140 // subresource extent dimensions.
2141 VkExtent3D offset_extent_sum = {};
2142 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2143 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2144 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002145 bool x_ok = true;
2146 bool y_ok = true;
2147 bool z_ok = true;
2148 switch (image_type) {
2149 case VK_IMAGE_TYPE_3D:
2150 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2151 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002152 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002153 case VK_IMAGE_TYPE_2D:
2154 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2155 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002156 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002157 case VK_IMAGE_TYPE_1D:
2158 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2159 (subresource_extent->width == offset_extent_sum.width));
2160 break;
2161 default:
2162 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2163 assert(false);
2164 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002165 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002166 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 -04002167 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002168 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2169 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2170 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2171 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2172 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2173 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002174 }
2175 }
2176 return skip;
2177}
2178
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002179bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002180 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002181 bool skip = false;
2182 if (mip_level >= img->createInfo.mipLevels) {
2183 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2184 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002185 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2186 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002187 }
2188 return skip;
2189}
2190
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002191bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002192 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002193 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002194 bool skip = false;
2195 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2196 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2198 HandleToUint64(cb_node->commandBuffer), vuid,
2199 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002200 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002201 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2202 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002203 }
2204 return skip;
2205}
2206
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002207// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002208bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002209 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002210 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002211 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002212 VkExtent3D granularity = GetScaledItg(cb_node, img);
2213 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002214 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002215 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002216 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002217 return skip;
2218}
2219
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002220// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002221bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002222 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002223 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002224 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002225 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002226 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2227 skip |=
2228 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002230 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002231 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2232 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002234 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002235 granularity = GetScaledItg(cb_node, dst_img);
2236 skip |=
2237 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002238 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002239 const VkExtent3D dest_effective_extent =
2240 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002241 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002242 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002243 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002244 return skip;
2245}
2246
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002248bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002249 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002250 bool skip = false;
2251
2252 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002253 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002254
2255 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002256 const VkExtent3D src_copy_extent = region.extent;
2257 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002258 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2259
Dave Houlton6f9059e2017-05-02 17:15:13 -06002260 bool slice_override = false;
2261 uint32_t depth_slices = 0;
2262
2263 // Special case for copying between a 1D/2D array and a 3D image
2264 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2265 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002266 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 slice_override = (depth_slices != 1);
2268 } 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 -07002269 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 slice_override = (depth_slices != 1);
2271 }
2272
2273 // Do all checks on source image
2274 //
2275 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002276 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2277 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 -06002278 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002279 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002280 "be 0 and 1, respectively.",
2281 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 }
2283 }
2284
Dave Houlton533be9f2018-03-26 17:08:30 -06002285 // VUID-VkImageCopy-srcImage-01785
2286 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2287 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 -06002288 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002289 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002290 "these must be 0 and 1, respectively.",
2291 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292 }
2293
Dave Houlton533be9f2018-03-26 17:08:30 -06002294 // VUID-VkImageCopy-srcImage-01787
2295 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2296 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 -06002297 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002298 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2299 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002300 }
2301
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002302 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002304 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002305 skip |=
2306 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002307 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002308 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002309 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2310 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002311 }
2312 }
2313 } else { // Pre maint 1
2314 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002315 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002316 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 -06002317 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002318 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2319 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002320 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2321 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002322 }
2323 }
2324 }
2325
Dave Houltonc991cc92018-03-06 11:08:51 -07002326 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07002327 bool ext_ycbcr = IsExtEnabled(device_extensions.vk_khr_sampler_ycbcr_conversion);
Dave Houltonc991cc92018-03-06 11:08:51 -07002328 if (FormatIsCompressed(src_state->createInfo.format) ||
2329 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002330 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002331 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002332 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2333 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2334 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002335 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 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 -07002337 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002338 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002339 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002340 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002341 }
2342
Dave Houlton94a00372017-12-14 15:08:47 -07002343 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002344 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2345 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002346 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002347 skip |=
2348 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002349 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002350 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002351 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002352 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002353 }
2354
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002355 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002356 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2357 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002358 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002359 skip |=
2360 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002361 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002362 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002363 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002364 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002365 }
2366
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002367 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002368 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2369 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002370 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002371 skip |=
2372 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002373 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002374 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002375 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002376 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002377 }
2378 } // Compressed
2379
2380 // Do all checks on dest image
2381 //
2382 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002383 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002384 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 -06002385 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002386 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002387 "these must be 0 and 1, respectively.",
2388 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002389 }
2390 }
2391
Dave Houlton533be9f2018-03-26 17:08:30 -06002392 // VUID-VkImageCopy-dstImage-01786
2393 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2394 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002395 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002396 "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 -06002397 "and 1, respectively.",
2398 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002399 }
2400
2401 // VUID-VkImageCopy-dstImage-01788
2402 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2403 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 -06002404 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002405 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2406 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002407 }
2408
2409 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002410 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002412 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002413 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002414 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2415 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002416 }
2417 }
2418 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002419 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002420 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002421 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 skip |=
2423 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002424 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002426 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2427 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428 }
2429 }
2430 } else { // Pre maint 1
2431 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002432 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002433 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 -06002434 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002435 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2436 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002437 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2438 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002439 }
2440 }
2441 }
2442
Dave Houltonc991cc92018-03-06 11:08:51 -07002443 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2444 if (FormatIsCompressed(dst_state->createInfo.format) ||
2445 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002446 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002447
2448 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002449 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2450 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2451 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002452 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002453 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 -07002454 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002455 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002456 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002457 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458 }
2459
Dave Houlton94a00372017-12-14 15:08:47 -07002460 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002461 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2462 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002463 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002464 skip |=
2465 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002466 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002467 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002468 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002469 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002470 }
2471
Dave Houltonee281a52017-12-08 13:51:02 -07002472 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2473 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2474 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002475 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002476 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 -07002477 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002478 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2479 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002480 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002481 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 }
2483
Dave Houltonee281a52017-12-08 13:51:02 -07002484 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2485 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2486 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002487 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002488 skip |=
2489 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002490 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002491 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002492 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002493 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002494 }
2495 } // Compressed
2496 }
2497 return skip;
2498}
2499
Dave Houltonc991cc92018-03-06 11:08:51 -07002500// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002501bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002502 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002503 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002504
2505 // Neither image is multiplane
2506 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2507 // If neither image is multi-plane the aspectMask member of src and dst must match
2508 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2509 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002510 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002511 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002513 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002514 }
2515 } else {
2516 // Source image multiplane checks
2517 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2518 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2519 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2520 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002521 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002522 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 -06002523 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002524 }
2525 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2526 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2527 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002528 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002529 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 -06002530 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002531 }
2532 // Single-plane to multi-plane
2533 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2534 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2535 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002536 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002538 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002539 }
2540
2541 // Dest image multiplane checks
2542 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2543 aspect = region.dstSubresource.aspectMask;
2544 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2545 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002546 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002547 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 -06002548 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002549 }
2550 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2551 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2552 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002553 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002554 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 -06002555 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002556 }
2557 // Multi-plane to single-plane
2558 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2559 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2560 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002561 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002562 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002563 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002564 }
2565 }
2566
2567 return skip;
2568}
2569
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002570bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2571 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002572 const VkImageCopy *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002573 const auto *cb_node = GetCBState(commandBuffer);
2574 const auto *src_image_state = GetImageState(srcImage);
2575 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002576 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002577
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002578 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002579
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002580 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2581
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002582 for (uint32_t i = 0; i < regionCount; i++) {
2583 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002584
2585 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2586 VkExtent3D src_copy_extent = region.extent;
2587 VkExtent3D dst_copy_extent =
2588 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2589
Dave Houlton6f9059e2017-05-02 17:15:13 -06002590 bool slice_override = false;
2591 uint32_t depth_slices = 0;
2592
2593 // Special case for copying between a 1D/2D array and a 3D image
2594 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2595 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2596 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002597 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002598 slice_override = (depth_slices != 1);
2599 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2600 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002601 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002602 slice_override = (depth_slices != 1);
2603 }
2604
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002605 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2606 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2607 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002608 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002609 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002610 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002611 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002612 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2613 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002614 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002615 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2616 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002617
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002618 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002619 // No chance of mismatch if we're overriding depth slice count
2620 if (!slice_override) {
2621 // The number of depth slices in srcSubresource and dstSubresource must match
2622 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2623 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002624 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2625 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002626 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002627 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2628 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002629 if (src_slices != dst_slices) {
2630 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002631 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002632 << "] do not match";
2633 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 -06002634 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002635 }
2636 }
2637 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002638 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002639 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002640 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002641 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002642 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002643 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 -06002644 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002645 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002646 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002647
Dave Houltonc991cc92018-03-06 11:08:51 -07002648 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002649 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002650 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002651 }
2652
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002653 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002654 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2655 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002656 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002657 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 -06002658 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002659 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002660 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002661
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002662 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002663 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002664 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002665 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002666 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2667 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 -06002668 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002669 }
2670
2671 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002672 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002673 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002674 ss << "vkCmdCopyImage(): pRegion[" << i
2675 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002676 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 -06002677 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002678 }
2679
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002680 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2681 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2682 // 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 -07002683 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2684 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002685 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002686 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002687 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2688 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2689 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002691 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002692 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002693
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002694 // 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 -07002695 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2696 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002697 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002698 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002699 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2700 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2701 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002702 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 -06002703 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002704 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002705 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002706
Dave Houltonfc1a4052017-04-27 14:32:45 -06002707 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002708 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2709 if (slice_override) src_copy_extent.depth = depth_slices;
2710 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002711 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002712 skip |=
2713 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2714 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2715 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2716 "width [%1d].",
2717 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002718 }
2719
2720 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002721 skip |=
2722 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2723 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2724 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2725 "height [%1d].",
2726 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002727 }
2728 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002729 skip |=
2730 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2731 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2732 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2733 "depth [%1d].",
2734 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002735 }
2736
Dave Houltonee281a52017-12-08 13:51:02 -07002737 // Adjust dest extent if necessary
2738 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2739 if (slice_override) dst_copy_extent.depth = depth_slices;
2740
2741 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002742 if (extent_check & x_bit) {
2743 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 -06002744 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002745 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002746 "width [%1d].",
2747 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002748 }
2749 if (extent_check & y_bit) {
2750 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 -06002751 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002752 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002753 "height [%1d].",
2754 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002755 }
2756 if (extent_check & z_bit) {
2757 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 -06002758 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002759 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002760 "depth [%1d].",
2761 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002762 }
2763
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002764 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2765 // must not overlap in memory
2766 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002767 for (uint32_t j = 0; j < regionCount; j++) {
2768 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002769 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002770 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002771 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002772 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 -06002773 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002774 }
2775 }
2776 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002777 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002778
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002779 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2780 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2781 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002782 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002783 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2784 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002785 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 -06002786 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002787 }
2788 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002789 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002790 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2791 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 -06002792 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002793 }
2794 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002795
Dave Houlton33c22b72017-02-28 13:16:02 -07002796 // Source and dest image sample counts must match
2797 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2798 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2799 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002800 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002801 }
2802
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002803 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2804 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002805 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002806 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2807 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2808 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2809 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002810 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002811 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2812 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2813 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2814 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002815 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002816 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002817 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002818 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2819 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002820 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002821 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2822 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2823 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2824 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2825 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2826 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002827 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002828 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002829 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2830 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002831 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002832 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2833 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002834 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2835 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002836 }
2837
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002838 return skip;
2839}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002840
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002841void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2842 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2843 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002844 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2845 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002846 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002847 auto src_image_state = GetImageState(srcImage);
2848 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002849
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002850 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002851 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002852 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2853 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002854 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002855}
2856
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002857// Returns true if sub_rect is entirely contained within rect
2858static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2859 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2860 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2861 return false;
2862 return true;
2863}
2864
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002865bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002866 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2867 const VkRect2D &render_area, uint32_t rect_count,
2868 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002869 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002870 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2871 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002872 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002873 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002874
2875 for (uint32_t j = 0; j < rect_count; j++) {
2876 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002877 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 -07002878 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2879 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2880 "the current render pass instance.",
2881 j);
2882 }
2883
2884 if (image_view_state) {
2885 // The layers specified by a given element of pRects must be contained within every attachment that
2886 // pAttachments refers to
2887 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2888 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2889 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002890 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2891 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2892 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2893 "of pAttachment[%d].",
2894 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002895 }
2896 }
2897 }
2898 return skip;
2899}
2900
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002901bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2902 const VkClearAttachment *pAttachments, uint32_t rectCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002903 const VkClearRect *pRects) const {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002904 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002905 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002906 if (!cb_node) return skip;
2907
2908 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2909 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2910 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Petr Kraus2dffb382019-08-10 02:52:12 +02002911 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002912
2913 // Validate that attachment is in reference list of active subpass
2914 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002915 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002916 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002917 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002918 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002919 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002920
John Zulauf3a548ef2019-02-01 16:14:07 -07002921 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2922 auto clear_desc = &pAttachments[attachment_index];
2923 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002924
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002925 if (0 == clear_desc->aspectMask) {
2926 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 -06002927 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002928 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2929 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 -06002930 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002931 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002932 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2933 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2934 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2935 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2937 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2938 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2939 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2940 attachment_index, clear_desc->colorAttachment,
2941 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2942 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2943 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002944
John Zulauff2582972019-02-09 14:53:30 -07002945 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2946 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002947 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2949 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002950 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002951 " subpass %u. colorAttachmentCount=%u",
2952 attachment_index, clear_desc->colorAttachment,
2953 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2954 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002955 }
John Zulauff2582972019-02-09 14:53:30 -07002956 fb_attachment = color_attachment;
2957
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002958 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2959 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2960 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002961 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002962 skip |=
2963 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2964 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002965 }
2966 } else { // Must be depth and/or stencil
2967 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2968 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002969 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002970 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 -07002971 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2972 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002973 }
2974 if (!subpass_desc->pDepthStencilAttachment ||
2975 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2976 skip |= log_msg(
2977 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002978 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002979 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002980 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002981 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002982 }
2983 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002984 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002985 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2986 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002987 }
2988 }
2989 }
2990 return skip;
2991}
2992
2993void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2994 const VkClearAttachment *pAttachments, uint32_t rectCount,
2995 const VkClearRect *pRects) {
2996 auto *cb_node = GetCBState(commandBuffer);
2997 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2998 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2999 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3000 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3001 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3002 const auto clear_desc = &pAttachments[attachment_index];
3003 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3004 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3005 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3006 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3007 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3008 subpass_desc->pDepthStencilAttachment) {
3009 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3010 }
3011 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003012 if (!clear_rect_copy) {
3013 // We need a copy of the clear rectangles that will persist until the last lambda executes
3014 // but we want to create it as lazily as possible
3015 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003016 }
John Zulauf441558b2019-08-12 11:47:39 -06003017 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3018 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003019 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003020 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003021 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003022 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003023 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3024 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003025 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3026 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003027 return skip;
3028 };
3029 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003030 }
3031 }
3032 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003033}
3034
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003035bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3036 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003037 const VkImageResolve *pRegions) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003038 const auto *cb_node = GetCBState(commandBuffer);
3039 const auto *src_image_state = GetImageState(srcImage);
3040 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003041
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003042 bool skip = false;
3043 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003044 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3045 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003046 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003047 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003048 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3049 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003050 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3051 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003052
Cort Stratton7df30962018-05-17 19:45:57 -07003053 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003054 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003055 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003056 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3057 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3058 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003059 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003060 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3061 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003062 // For each region, the number of layers in the image subresource should not be zero
3063 // For each region, src and dest image aspect must be color only
3064 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003065 skip |=
3066 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3067 skip |=
3068 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003069 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003070 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3071 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003072 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003073 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3074 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003075 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3076 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3077 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3078 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3079 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003080 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3081 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003082 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003083 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3084 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003085
3086 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003087 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3088 skip |= log_msg(
3089 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003090 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003091 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003092 }
Cort Stratton7df30962018-05-17 19:45:57 -07003093 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003094 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3095 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3096 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003097 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003098 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003099 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003100 }
3101 }
3102
3103 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3104 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003105 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 -06003106 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003107 }
3108 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3109 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003110 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 -06003111 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003112 }
3113 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3114 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3115 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 -06003116 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003117 }
3118 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3119 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3120 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 -06003121 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003122 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003123 } else {
3124 assert(0);
3125 }
3126 return skip;
3127}
3128
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003129bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3130 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003131 const VkImageBlit *pRegions, VkFilter filter) const {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003132 const auto *cb_node = GetCBState(commandBuffer);
3133 const auto *src_image_state = GetImageState(srcImage);
3134 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003135
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003136 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003137 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003138 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003139 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003140 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003141 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003142 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003143 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003144 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003145 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3146 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003147 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003148 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3149 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003150 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003151 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3152 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003153 skip |=
3154 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003155 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3156 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003157 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003158 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003159 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003160 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003161
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003162 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003163
Dave Houlton33c2d252017-06-09 17:08:32 -06003164 VkFormat src_format = src_image_state->createInfo.format;
3165 VkFormat dst_format = dst_image_state->createInfo.format;
3166 VkImageType src_type = src_image_state->createInfo.imageType;
3167 VkImageType dst_type = dst_image_state->createInfo.imageType;
3168
Cort Stratton186b1a22018-05-01 20:18:06 -04003169 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003170 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003171 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3172 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003173 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003174 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3175 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3176 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003177 }
3178
3179 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3180 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 -06003181 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003182 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003183 }
3184
Dave Houlton33c2d252017-06-09 17:08:32 -06003185 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3186 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3187 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 -06003188 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003189 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 }
3191
3192 // Validate consistency for unsigned formats
3193 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3194 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003195 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003196 << "the other one must also have unsigned integer format. "
3197 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3198 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 -06003199 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003200 }
3201
3202 // Validate consistency for signed formats
3203 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3204 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003205 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003206 << "the other one must also have signed integer format. "
3207 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3208 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 -06003209 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003210 }
3211
3212 // Validate filter for Depth/Stencil formats
3213 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3214 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003215 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003216 << "then filter must be VK_FILTER_NEAREST.";
3217 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 -06003218 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003219 }
3220
3221 // Validate aspect bits and formats for depth/stencil images
3222 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3223 if (src_format != dst_format) {
3224 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003225 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003226 << "stencil, the other one must have exactly the same format. "
3227 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3228 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003229 skip |=
3230 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3231 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003233 } // Depth or Stencil
3234
3235 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003236 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003237 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003238 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3239 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3240 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003241 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003242 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3243 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003244 for (uint32_t i = 0; i < regionCount; i++) {
3245 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003246 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003247 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003248 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3249 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003250 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003251 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3252 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003253 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3254 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3255 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003256 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003257 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003258 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003259 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003260 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3261 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003262 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003263 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3264 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003265 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003266 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3267 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003268 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003269 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003270 skip |=
3271 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3272 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003273 }
Dave Houlton48989f32017-05-26 15:01:46 -06003274 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3275 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003276 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003277 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003278 skip |=
3279 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3280 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003281 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003282
3283 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003284 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003285 skip |= log_msg(
3286 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3287 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3288 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003289 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003290
Dave Houlton48989f32017-05-26 15:01:46 -06003291 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003292 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 -06003293 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003294 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003295 }
Dave Houlton48989f32017-05-26 15:01:46 -06003296
Dave Houlton33c2d252017-06-09 17:08:32 -06003297 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3298 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 -06003299 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003300 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003301 "image format %s.",
3302 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003303 }
3304
3305 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3306 skip |= log_msg(
3307 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003308 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003309 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3310 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003311 }
3312
Dave Houlton48989f32017-05-26 15:01:46 -06003313 // Validate source image offsets
3314 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003315 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003316 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003317 skip |=
3318 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3319 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3320 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3321 "of (%1d, %1d). These must be (0, 1).",
3322 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003323 }
3324 }
3325
Dave Houlton33c2d252017-06-09 17:08:32 -06003326 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003327 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3328 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 -06003329 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003330 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003331 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3332 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003333 }
3334 }
3335
Dave Houlton33c2d252017-06-09 17:08:32 -06003336 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003337 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3338 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003339 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003340 skip |= log_msg(
3341 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3342 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3343 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3344 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003345 }
3346 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3347 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003348 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003349 skip |= log_msg(
3350 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003351 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003352 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003353 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003354 }
3355 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3356 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003357 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003358 skip |= log_msg(
3359 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3360 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3361 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3362 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003363 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003364 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003365 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 -06003366 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003367 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003368 }
Dave Houlton48989f32017-05-26 15:01:46 -06003369
3370 // Validate dest image offsets
3371 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003372 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003373 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003374 skip |=
3375 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3376 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3377 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3378 "(%1d, %1d). These must be (0, 1).",
3379 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003380 }
3381 }
3382
Dave Houlton33c2d252017-06-09 17:08:32 -06003383 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003384 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3385 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 -06003386 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003387 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003388 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3389 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003390 }
3391 }
3392
Dave Houlton33c2d252017-06-09 17:08:32 -06003393 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003394 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3395 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003396 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003397 skip |= log_msg(
3398 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3399 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3400 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3401 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003402 }
3403 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3404 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003405 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003406 skip |= log_msg(
3407 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003408 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003409 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003410 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003411 }
3412 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3413 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003414 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003415 skip |= log_msg(
3416 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3417 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3418 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3419 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003420 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003421 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003422 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 -06003423 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003424 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003425 }
3426
Dave Houlton33c2d252017-06-09 17:08:32 -06003427 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3428 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3429 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003430 skip |=
3431 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3432 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3433 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3434 "layerCount other than 1.",
3435 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003436 }
3437 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003438 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003439 } else {
3440 assert(0);
3441 }
3442 return skip;
3443}
3444
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003445void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3446 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3447 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003448 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3449 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003450 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003451 auto src_image_state = GetImageState(srcImage);
3452 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003453
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003454 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003455 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003456 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3457 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003458 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003459}
3460
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003461// 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 -06003462bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3463 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003464 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003465 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003466 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003467 // Iterate over the layout maps for each referenced image
3468 for (const auto &layout_map_entry : pCB->image_layout_map) {
3469 const auto image = layout_map_entry.first;
3470 const auto *image_state = GetImageState(image);
3471 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003472 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003473 ImageSubresourcePair isr_pair;
3474 isr_pair.image = image;
3475 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003476 // Validate the initial_uses for each subresource referenced
John Zulauf6066f732019-11-21 13:15:10 -07003477 for (const auto &pos : subres_map->InitialLayoutView()) {
3478 isr_pair.subresource = pos.subresource;
3479 VkImageLayout initial_layout = pos.it->second; // Point directly into the RangeMap iterated but the view
John Zulauff660ad62019-03-23 07:16:05 -06003480 VkImageLayout image_layout;
3481 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3482 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3483 // TODO: Set memory invalid which is in mem_tracker currently
3484 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003485 // Need to look up the inital layout *state* to get a bit more information
3486 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3487 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3488 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3489 if (!matches) {
3490 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003491 skip |= log_msg(
3492 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3493 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003494 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003495 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003496 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003497 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3498 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003499 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003500 }
3501 }
John Zulauff660ad62019-03-23 07:16:05 -06003502 }
3503
3504 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003505 for (const auto &pos : subres_map->CurrentLayoutView()) {
3506 VkImageLayout layout = pos.it->second;
3507 assert(layout != kInvalidLayout);
3508 isr_pair.subresource = pos.subresource;
3509 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003510 }
3511 }
John Zulauff660ad62019-03-23 07:16:05 -06003512
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003513 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003514}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003515
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003516void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003517 for (const auto &layout_map_entry : pCB->image_layout_map) {
3518 const auto image = layout_map_entry.first;
3519 const auto *image_state = GetImageState(image);
3520 if (!image_state) continue; // Can't set layouts of a dead image
3521 const auto &subres_map = layout_map_entry.second;
3522 ImageSubresourcePair isr_pair;
3523 isr_pair.image = image;
3524 isr_pair.hasSubresource = true;
3525
3526 // Update all layout set operations (which will be a subset of the initial_layouts
John Zulauf6066f732019-11-21 13:15:10 -07003527 for (const auto &pos : subres_map->CurrentLayoutView()) {
3528 VkImageLayout layout = pos.it->second;
3529 assert(layout != kInvalidLayout);
3530 isr_pair.subresource = pos.subresource;
3531 SetGlobalLayout(isr_pair, layout);
John Zulauff660ad62019-03-23 07:16:05 -06003532 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003533 }
3534}
3535
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003536// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003537// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3538// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003539bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3540 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003541 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003542 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003543 const char *vuid;
3544 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3545
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003546 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3547 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003548 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3549 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3550 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003551 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003552 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 -08003553 "VUID-VkRenderPassCreateInfo2-pAttachments-02522",
Shannon McPherson3ea65132018-12-05 10:37:39 -07003554 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3555 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3556 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3557 skip |=
3558 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3559 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003560 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003561 }
3562 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003563 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3564 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003565 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003566 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003567 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 -06003568 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003569 }
3570 }
3571
3572 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3573 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003574 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003575 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003576 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 -06003577 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003578 }
3579 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003580 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003581}
3582
Mark Lobodzinskiac02c612020-01-17 14:52:35 -07003583bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device, const VkRenderPassCreateInfo2KHR *pCreateInfo,
3584 const char *function_name) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003585 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003586 const char *vuid;
3587 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003588
Jason Ekstranda1906302017-12-03 20:16:32 -08003589 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3590 VkFormat format = pCreateInfo->pAttachments[i].format;
3591 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3592 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3593 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003594 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 -06003595 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003596 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3597 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3598 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3599 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003600 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003601 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003602 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 -06003603 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003604 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3605 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3606 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3607 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003608 }
3609 }
3610 }
3611
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003612 // Track when we're observing the first use of an attachment
3613 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3614 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003615 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003616
3617 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3618 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3619 auto attach_index = subpass.pInputAttachments[j].attachment;
3620 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003621 switch (subpass.pInputAttachments[j].layout) {
3622 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3623 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3624 // These are ideal.
3625 break;
3626
3627 case VK_IMAGE_LAYOUT_GENERAL:
3628 // May not be optimal. TODO: reconsider this warning based on other constraints.
3629 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003630 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003631 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3632 break;
3633
Tobias Hectorbbb12282018-10-22 15:17:59 +01003634 case VK_IMAGE_LAYOUT_UNDEFINED:
3635 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003636 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003637 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3638 "Layout for input attachment reference %u in subpass %u is %s but must be "
3639 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003640 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003641 break;
3642
Piers Daniell9af77cd2019-10-16 13:54:12 -06003643 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3644 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3645 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3646 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003647 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003648 skip |= log_msg(
3649 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003650 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003651 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3652 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3653 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3654 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3655 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3656 skip |= log_msg(
3657 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003658 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003659 "Layout for input attachment reference %u in subpass %u is %s but must not be "
3660 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3661 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3662 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
3663 } else if ((subpass.pInputAttachments[j].aspectMask &
3664 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3665 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3666 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3667 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3668 const auto *attachment_reference_stencil_layout =
3669 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pInputAttachments[j].pNext);
3670 if (attachment_reference_stencil_layout) {
3671 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3672 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3673 attachment_reference_stencil_layout->stencilLayout ==
3674 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3675 attachment_reference_stencil_layout->stencilLayout ==
3676 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3677 attachment_reference_stencil_layout->stencilLayout ==
3678 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3679 attachment_reference_stencil_layout->stencilLayout ==
3680 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3681 attachment_reference_stencil_layout->stencilLayout ==
3682 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3683 attachment_reference_stencil_layout->stencilLayout ==
3684 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3685 attachment_reference_stencil_layout->stencilLayout ==
3686 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3687 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3688 skip |=
3689 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003690 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003691 "In the attachment reference %u in subpass %u with pNext chain instance "
3692 "VkAttachmentReferenceStencilLayoutKHR"
3693 "the stencilLayout member but must not be "
3694 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3695 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3696 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3697 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3698 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3699 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3700 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3701 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3702 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3703 j, i);
3704 }
3705 } else {
3706 skip |=
3707 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 -08003708 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003709 "When the layout for input attachment reference %u in subpass %u is "
3710 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3711 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3712 "VkAttachmentReferenceStencilLayout instance.",
3713 j, i);
3714 }
3715 }
3716 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3717 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3718 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3719 skip |= log_msg(
3720 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003721 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003722 "When the aspectMask for input attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3723 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3724 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3725 j, i);
3726 }
3727 } else if (subpass.pInputAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3728 if (subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3729 subpass.pInputAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3730 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 -08003731 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003732 "When the aspectMask for input attachment reference %u in subpass %u is "
3733 "VK_IMAGE_ASPECT_STENCIL_BIT "
3734 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3735 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3736 j, i);
3737 }
3738 }
3739 break;
3740
Graeme Leese668a9862018-10-08 10:40:02 +01003741 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3742 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003743 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003744 break;
3745 } else {
3746 // Intentionally fall through to generic error message
3747 }
3748 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003749
Cort Stratton7547f772017-05-04 15:18:52 -07003750 default:
3751 // No other layouts are acceptable
3752 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 -06003753 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003754 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3755 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3756 }
3757
Cort Stratton7547f772017-05-04 15:18:52 -07003758 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003759 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3760 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003761
3762 bool used_as_depth =
3763 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3764 bool used_as_color = false;
3765 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3766 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3767 }
3768 if (!used_as_depth && !used_as_color &&
3769 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003770 vuid = use_rp2 ? "VUID-VkSubpassDescription2-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003771 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3772 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3773 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003774 }
3775 }
3776 attach_first_use[attach_index] = false;
3777 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003778
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003779 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3780 auto attach_index = subpass.pColorAttachments[j].attachment;
3781 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3782
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003783 // TODO: Need a way to validate shared presentable images here, currently just allowing
3784 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3785 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003786 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003787 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003788 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003789 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3790 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003791 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003792
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003793 case VK_IMAGE_LAYOUT_GENERAL:
3794 // May not be optimal; TODO: reconsider this warning based on other constraints?
3795 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003796 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003797 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3798 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003799
Tobias Hectorbbb12282018-10-22 15:17:59 +01003800 case VK_IMAGE_LAYOUT_UNDEFINED:
3801 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003802 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003803 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3804 "Layout for color attachment reference %u in subpass %u is %s but should be "
3805 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3806 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3807 break;
3808
Piers Daniell9af77cd2019-10-16 13:54:12 -06003809 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3810 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3811 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3812 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003813 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003814 skip |= log_msg(
3815 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003816 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003817 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3818 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3819 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3820 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3821 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3822 skip |= log_msg(
3823 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003824 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003825 "Layout for color attachment reference %u in subpass %u is %s but must not be "
3826 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3827 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3828 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3829 } else if ((subpass.pColorAttachments[j].aspectMask &
3830 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3831 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3832 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3833 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3834 const auto *attachment_reference_stencil_layout =
3835 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pColorAttachments[j].pNext);
3836 if (attachment_reference_stencil_layout) {
3837 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3838 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3839 attachment_reference_stencil_layout->stencilLayout ==
3840 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3841 attachment_reference_stencil_layout->stencilLayout ==
3842 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3843 attachment_reference_stencil_layout->stencilLayout ==
3844 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3845 attachment_reference_stencil_layout->stencilLayout ==
3846 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3847 attachment_reference_stencil_layout->stencilLayout ==
3848 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3849 attachment_reference_stencil_layout->stencilLayout ==
3850 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3851 attachment_reference_stencil_layout->stencilLayout ==
3852 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3853 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
3854 skip |=
3855 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003856 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003857 "In the attachment reference %u in subpass %u with pNext chain instance "
3858 "VkAttachmentReferenceStencilLayoutKHR"
3859 "the stencilLayout member but must not be "
3860 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
3861 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
3862 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
3863 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3864 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3865 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
3866 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
3867 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
3868 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
3869 j, i);
3870 }
3871 } else {
3872 skip |=
3873 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 -08003874 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003875 "When the layout for color attachment reference %u in subpass %u is "
3876 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
3877 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
3878 "VkAttachmentReferenceStencilLayout instance.",
3879 j, i);
3880 }
3881 }
3882 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
3883 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
3884 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
3885 skip |= log_msg(
3886 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003887 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003888 "When the aspectMask for color attachment reference %u in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
3889 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
3890 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3891 j, i);
3892 }
3893 } else if (subpass.pColorAttachments[j].aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
3894 if (subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3895 subpass.pColorAttachments[j].layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3896 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 -08003897 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003898 "When the aspectMask for color attachment reference %u in subpass %u is "
3899 "VK_IMAGE_ASPECT_STENCIL_BIT "
3900 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
3901 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
3902 j, i);
3903 }
3904 }
3905 break;
3906
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003907 default:
3908 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 -06003909 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003910 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3911 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003912 }
3913
John Zulauf4eee2692019-02-09 16:14:25 -07003914 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3915 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3916 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Mike Schuchardt65847d92019-12-20 13:50:47 -08003917 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003918 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 -07003919 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003920 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003921 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003922 }
3923
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003924 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003925 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3926 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003927 }
3928 attach_first_use[attach_index] = false;
3929 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003930
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003931 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3932 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003933 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3934 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3935 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003936 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003937
Dave Houltona9df0ce2018-02-07 10:51:23 -07003938 case VK_IMAGE_LAYOUT_GENERAL:
3939 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3940 // doing a bunch of transitions.
3941 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003942 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003943 "GENERAL layout for depth attachment may not give optimal performance.");
3944 break;
3945
Tobias Hectorbbb12282018-10-22 15:17:59 +01003946 case VK_IMAGE_LAYOUT_UNDEFINED:
3947 case VK_IMAGE_LAYOUT_PREINITIALIZED:
Mike Schuchardt65847d92019-12-20 13:50:47 -08003948 vuid = use_rp2 ? "VUID-VkAttachmentReference2-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
Tobias Hectorbbb12282018-10-22 15:17:59 +01003949 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3950 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3951 "layout or GENERAL.",
3952 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3953 break;
3954
Piers Daniell9af77cd2019-10-16 13:54:12 -06003955 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR:
3956 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR:
3957 case VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3958 case VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Piers Daniell41b8c5d2020-01-10 15:42:00 -07003959 if (!enabled_features.core12.separateDepthStencilLayouts) {
Piers Daniell9af77cd2019-10-16 13:54:12 -06003960 skip |= log_msg(
3961 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003962 "VUID-VkAttachmentReference2-separateDepthStencilLayouts-03313",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003963 "Layout for depth attachment reference in subpass %u is %s but must not be "
3964 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3965 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3966 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3967 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3968 skip |= log_msg(
3969 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08003970 "VUID-VkAttachmentReference2-attachment-03314",
Piers Daniell9af77cd2019-10-16 13:54:12 -06003971 "Layout for depth attachment reference in subpass %u is %s but must not be "
3972 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
3973 "VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
3974 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3975 } else if ((subpass.pDepthStencilAttachment->aspectMask &
3976 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) ==
3977 (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3978 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3979 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
3980 const auto *attachment_reference_stencil_layout =
3981 lvl_find_in_chain<VkAttachmentReferenceStencilLayoutKHR>(subpass.pDepthStencilAttachment->pNext);
3982 if (attachment_reference_stencil_layout) {
3983 if (attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_UNDEFINED ||
3984 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PREINITIALIZED ||
3985 attachment_reference_stencil_layout->stencilLayout ==
3986 VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ||
3987 attachment_reference_stencil_layout->stencilLayout ==
3988 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
3989 attachment_reference_stencil_layout->stencilLayout ==
3990 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR ||
3991 attachment_reference_stencil_layout->stencilLayout ==
3992 VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
3993 attachment_reference_stencil_layout->stencilLayout ==
3994 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL ||
3995 attachment_reference_stencil_layout->stencilLayout ==
3996 VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
3997 attachment_reference_stencil_layout->stencilLayout ==
3998 VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
3999 attachment_reference_stencil_layout->stencilLayout == VK_IMAGE_LAYOUT_PRESENT_SRC_KHR) {
4000 skip |=
4001 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004002 0, "VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004003 "In the attachment reference in subpass %u with pNext chain instance "
4004 "VkAttachmentReferenceStencilLayoutKHR"
4005 "the stencilLayout member but must not be "
4006 "VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_PREINITIALIZED, "
4007 "VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, "
4008 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, "
4009 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, "
4010 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4011 "VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, "
4012 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, "
4013 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or "
4014 "VK_IMAGE_LAYOUT_PRESENT_SRC_KHR.",
4015 i);
4016 }
4017 } else {
4018 skip |=
4019 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 -08004020 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004021 "When the layout for depth attachment reference in subpass %u is "
4022 "VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or "
4023 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR then the pNext chain must include a valid "
4024 "VkAttachmentReferenceStencilLayout instance.",
4025 i);
4026 }
4027 }
4028 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4029 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR ||
4030 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR) {
4031 skip |= log_msg(
4032 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Mike Schuchardt65847d92019-12-20 13:50:47 -08004033 "VUID-VkAttachmentReference2-attachment-03315",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004034 "When the aspectMask for depth attachment reference in subpass %u is VK_IMAGE_ASPECT_DEPTH_BIT "
4035 "then the layout must not be VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or "
4036 "VK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR.",
4037 i);
4038 }
4039 } else if (subpass.pDepthStencilAttachment->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
4040 if (subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR ||
4041 subpass.pDepthStencilAttachment->layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR) {
4042 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 -08004043 "VUID-VkAttachmentReference2-attachment-03317",
Piers Daniell9af77cd2019-10-16 13:54:12 -06004044 "When the aspectMask for depth attachment reference in subpass %u is "
4045 "VK_IMAGE_ASPECT_STENCIL_BIT "
4046 "then the layout must not be VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, or "
4047 "VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL.",
4048 i);
4049 }
4050 }
4051 break;
4052
Dave Houltona9df0ce2018-02-07 10:51:23 -07004053 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
4054 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004055 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004056 break;
4057 } else {
4058 // Intentionally fall through to generic error message
4059 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06004060 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01004061
Dave Houltona9df0ce2018-02-07 10:51:23 -07004062 default:
4063 // No other layouts are acceptable
4064 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 -06004065 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004066 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
4067 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
4068 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004069 }
4070
4071 auto attach_index = subpass.pDepthStencilAttachment->attachment;
4072 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004073 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
4074 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004075 }
4076 attach_first_use[attach_index] = false;
4077 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07004078 }
4079 return skip;
4080}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07004081
Mark Lobodzinski96210742017-02-09 10:33:46 -07004082// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
4083// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06004084bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004085 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004086 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004087 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06004088 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07004089 if (strict) {
4090 correct_usage = ((actual & desired) == desired);
4091 } else {
4092 correct_usage = ((actual & desired) != 0);
4093 }
4094 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06004095 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06004096 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06004097 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
4098 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06004099 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4100 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004101 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06004102 skip =
4103 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 -06004104 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
4105 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004106 }
4107 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004108 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004109}
4110
4111// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4112// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004113bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004114 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004115 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
4116 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004117}
4118
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004119bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06004120 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004121 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04004122 bool skip = false;
4123 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
4124 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07004125 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4126 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004127 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07004128 format_properties.linearTilingFeatures, image_state->createInfo.format,
4129 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004130 }
4131 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
4132 if ((format_properties.optimalTilingFeatures & desired) != desired) {
4133 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4134 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06004135 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04004136 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07004137 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04004138 }
4139 }
4140 return skip;
4141}
4142
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06004143bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06004144 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07004145 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07004146 // layerCount must not be zero
4147 if (subresource_layers->layerCount == 0) {
4148 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4149 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
4150 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
4151 }
4152 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
4153 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
4154 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4155 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
4156 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
4157 }
4158 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
4159 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
4160 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4161 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
4162 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
4163 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
4164 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4165 func_name, i, member);
4166 }
4167 return skip;
4168}
4169
Mark Lobodzinski96210742017-02-09 10:33:46 -07004170// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
4171// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004172bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06004173 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06004174 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
4175 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004176}
4177
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004178bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004179 const VkPhysicalDeviceLimits *device_limits) const {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004180 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004181
4182 const VkDeviceSize &range = pCreateInfo->range;
4183 if (range != VK_WHOLE_SIZE) {
4184 // Range must be greater than 0
4185 if (range <= 0) {
4186 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4187 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
4188 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4189 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
4190 range);
4191 }
4192 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02004193 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
4194 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004195 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4196 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
4197 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4198 ") 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 +02004199 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004200 range, format_size);
4201 }
4202 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02004203 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
4204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4205 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
4206 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4207 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
4208 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
4209 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004210 }
4211 // The sum of range and offset must be less than or equal to the size of buffer
4212 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
4213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4214 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
4215 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
4216 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
4217 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
4218 range, pCreateInfo->offset, buffer_state->createInfo.size);
4219 }
4220 }
4221 return skip;
4222}
4223
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004224bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) const {
Shannon McPherson265383a2018-06-21 15:37:52 -06004225 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004226 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06004227 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
4228 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
4229 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4230 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
4231 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
4232 "be supported for uniform texel buffers");
4233 }
4234 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
4235 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
4236 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4237 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
4238 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
4239 "be supported for storage texel buffers");
4240 }
4241 return skip;
4242}
4243
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004244bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004245 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07004246 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004247
Dave Houltond8ed0212018-05-16 17:18:24 -06004248 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004249
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004250 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004251 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 -06004252 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004253 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004254 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06004255 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004256
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004257 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004258 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 -06004259 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004260 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004261 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004262 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004263
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004264 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004265 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 -06004266 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004267 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004268 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004269 }
Jeff Bolz87697532019-01-11 22:54:00 -06004270
4271 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4272 if (chained_devaddr_struct) {
4273 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4274 chained_devaddr_struct->deviceAddress != 0) {
4275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4276 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4277 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4278 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4279 }
4280 }
4281
Jeff Bolz4563f2a2019-12-10 13:30:30 -06004282 auto chained_opaqueaddr_struct = lvl_find_in_chain<VkBufferOpaqueCaptureAddressCreateInfoKHR>(pCreateInfo->pNext);
4283 if (chained_opaqueaddr_struct) {
4284 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
4285 chained_opaqueaddr_struct->opaqueCaptureAddress != 0) {
4286 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4287 "VUID-VkBufferCreateInfo-opaqueCaptureAddress-03337",
4288 "vkCreateBuffer(): Non-zero VkBufferOpaqueCaptureAddressCreateInfoKHR::opaqueCaptureAddress"
4289 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR.");
4290 }
4291 }
4292
Shannon McPherson4984e642019-12-05 13:04:34 -07004293 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR) &&
Piers Daniell41b8c5d2020-01-10 15:42:00 -07004294 !enabled_features.core12.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004295 skip |= log_msg(
4296 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Shannon McPherson4984e642019-12-05 13:04:34 -07004297 "VUID-VkBufferCreateInfo-flags-03338",
Jeff Bolz87697532019-01-11 22:54:00 -06004298 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4299 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4300 }
4301
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004302 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004303 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4304 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4305 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004306 }
4307
Mark Lobodzinski96210742017-02-09 10:33:46 -07004308 return skip;
4309}
4310
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004311bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004312 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) const {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004313 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004314 const BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004315 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4316 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004317 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004318 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4319 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004320 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004321 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4322 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4323 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004324
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004325 // Buffer view offset must be less than the size of buffer
4326 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4327 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4328 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4329 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4330 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4331 pCreateInfo->offset, buffer_state->createInfo.size);
4332 }
4333
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004334 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004335 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4336 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4337 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4339 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4340 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4341 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4342 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4343 }
4344
4345 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4346 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4347 if ((elementSize % 3) == 0) {
4348 elementSize /= 3;
4349 }
4350 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4351 VkDeviceSize alignmentRequirement =
4352 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4353 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4354 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4355 }
4356 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4357 skip |= log_msg(
4358 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4359 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4360 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4361 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4362 ") must be a multiple of the lesser of "
4363 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4364 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4365 "(%" PRId32
4366 ") is VK_TRUE, the size of a texel of the requested format. "
4367 "If the size of a texel is a multiple of three bytes, then the size of a "
4368 "single component of format is used instead",
4369 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4370 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4371 }
4372 }
4373 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4374 VkDeviceSize alignmentRequirement =
4375 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4376 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4377 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4378 }
4379 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4380 skip |= log_msg(
4381 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4382 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4383 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4384 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4385 ") must be a multiple of the lesser of "
4386 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4387 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4388 "(%" PRId32
4389 ") is VK_TRUE, the size of a texel of the requested format. "
4390 "If the size of a texel is a multiple of three bytes, then the size of a "
4391 "single component of format is used instead",
4392 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4393 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4394 }
4395 }
4396 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004397
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004398 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004399
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004400 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004401 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004402 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004403}
4404
Mark Lobodzinski602de982017-02-09 11:01:33 -07004405// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004406bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004407 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004408 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004409 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4410 if (image != VK_NULL_HANDLE) {
4411 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4412 }
4413
Dave Houlton1d2022c2017-03-29 11:43:58 -06004414 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004415 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004416 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004417 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004418 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004419 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004420 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004421 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004422 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004423 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004425 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004426 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4427 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004428 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004429 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004430 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004431 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4432 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004433 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004434 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004435 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004437 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004438 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004439 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004440 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004441 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004442 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004443 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004444 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004445 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004446 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004447 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004448 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004449 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004450 } else if (FormatIsMultiplane(format)) {
4451 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4452 if (3 == FormatPlaneCount(format)) {
4453 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4454 }
4455 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004456 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004457 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4458 "set, where n = [0, 1, 2].",
4459 func_name);
4460 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004461 }
4462 return skip;
4463}
4464
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004465bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4466 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4467 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004468 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004469 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004470
4471 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004472 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004473 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 -06004474 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004475 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004476 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4477 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004478 }
Petr Kraus4d718682017-05-18 03:38:41 +02004479
Petr Krausffa94af2017-08-08 21:46:02 +02004480 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4481 if (subresourceRange.levelCount == 0) {
4482 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 -06004483 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004484 } else {
4485 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004486
Petr Krausffa94af2017-08-08 21:46:02 +02004487 if (necessary_mip_count > image_mip_count) {
4488 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, image_handle,
Mark Lobodzinski88529492018-04-01 10:38:15 -06004489 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004490 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004491 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004492 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004493 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004494 }
Petr Kraus4d718682017-05-18 03:38:41 +02004495 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004496 }
Petr Kraus4d718682017-05-18 03:38:41 +02004497
4498 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004499 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004500 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 -06004501 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004502 "%s: %s.baseArrayLayer (= %" PRIu32
4503 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4504 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004505 }
Petr Kraus4d718682017-05-18 03:38:41 +02004506
Petr Krausffa94af2017-08-08 21:46:02 +02004507 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4508 if (subresourceRange.layerCount == 0) {
4509 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 -06004510 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004511 } else {
4512 const uint64_t necessary_layer_count =
4513 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004514
Petr Krausffa94af2017-08-08 21:46:02 +02004515 if (necessary_layer_count > image_layer_count) {
4516 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 -06004517 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004518 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004519 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004520 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004521 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004522 }
Petr Kraus4d718682017-05-18 03:38:41 +02004523 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004524 }
Petr Kraus4d718682017-05-18 03:38:41 +02004525
Mark Lobodzinski602de982017-02-09 11:01:33 -07004526 return skip;
4527}
4528
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004529bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004530 const VkImageSubresourceRange &subresourceRange) const {
Tony-LunarG2ec96bb2019-11-26 13:43:02 -07004531 bool is_khr_maintenance1 = IsExtEnabled(device_extensions.vk_khr_maintenance1);
Petr Krausffa94af2017-08-08 21:46:02 +02004532 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4533 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4534 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4535
4536 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4537 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4538
4539 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004540 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4541 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004542 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004543 : "VUID-VkImageViewCreateInfo-image-01482")
4544 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4545 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004546 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004547 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4548 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004549
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004550 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004551 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4552 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4553}
4554
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004555bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004556 const VkImageSubresourceRange &subresourceRange,
4557 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004558 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004559 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4560 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4561 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4562 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004563
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004564 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4565 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4566 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004567}
4568
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004569bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004570 const VkImageSubresourceRange &subresourceRange,
4571 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004572 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004573 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4574 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4575 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4576 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004577
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004578 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4579 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004580 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4581}
4582
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004583bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004584 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004585 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004586 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004587 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4588 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4589 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4590 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004591
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004592 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4593 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004594 subresourceRangeErrorCodes);
4595}
4596
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004597bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004598 const VkAllocationCallbacks *pAllocator, VkImageView *pView) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004599 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004600 const IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004601 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004602 skip |=
4603 ValidateImageUsageFlags(image_state,
4604 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4605 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4606 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4607 false, kVUIDUndefined, "vkCreateImageView()",
4608 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4609 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004610 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004611 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004612 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004613 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004614 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004615 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004616
4617 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4618 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004619 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4620 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004621 VkFormat view_format = pCreateInfo->format;
4622 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004623 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004624 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004625
Dave Houltonbd2e2622018-04-10 16:41:14 -06004626 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004627 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004628 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004629 image_usage = chained_ivuci_struct->usage;
4630 }
4631
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004632 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4633 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004634 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004635 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004636 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004637 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004638 std::stringstream ss;
4639 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004640 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004641 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004642 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 -07004643 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004644 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004645 }
4646 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004647 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004648 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4649 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4650 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4651 std::stringstream ss;
4652 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004653 << " is not in the same format compatibility class as "
4654 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004655 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4656 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004657 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 -07004658 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004659 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004660 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004661 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004662 }
4663 } else {
4664 // Format MUST be IDENTICAL to the format the image was created with
4665 if (image_format != view_format) {
4666 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004667 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004668 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004669 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004670 skip |=
4671 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004672 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004673 }
4674 }
4675
4676 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004677 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004678
4679 switch (image_type) {
4680 case VK_IMAGE_TYPE_1D:
4681 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004682 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 -07004683 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004684 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4685 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004686 }
4687 break;
4688 case VK_IMAGE_TYPE_2D:
4689 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4690 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4691 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004692 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 -07004693 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004694 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4695 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004696 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004697 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 -07004698 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004699 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4700 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004701 }
4702 }
4703 break;
4704 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004705 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004706 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4707 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4708 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004709 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004710 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004711 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004712 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4713 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004714 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4715 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004716 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004717 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004718 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004719 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4720 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004721 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4722 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004723 }
4724 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004725 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 -07004726 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004727 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4728 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004729 }
4730 }
4731 } else {
4732 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004733 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 -07004734 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004735 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4736 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004737 }
4738 }
4739 break;
4740 default:
4741 break;
4742 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004743
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004744 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004745 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004746 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004747 }
4748
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004749 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004750 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4751 : format_properties.optimalTilingFeatures;
4752
4753 if (tiling_features == 0) {
4754 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004755 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004756 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4757 "physical device.",
4758 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4759 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4760 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004761 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004762 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4763 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4764 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4765 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4766 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004767 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004768 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4769 "VK_IMAGE_USAGE_STORAGE_BIT.",
4770 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4771 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4772 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4773 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 -07004774 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004775 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4776 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4777 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4778 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4779 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4780 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 -07004781 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004782 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4783 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4784 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004785 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004786
Jeff Bolz9af91c52018-09-01 21:53:57 -05004787 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4788 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4789 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 -07004790 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004791 "vkCreateImageView() If image was created with usage containing "
4792 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4793 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4794 }
4795 if (view_format != VK_FORMAT_R8_UINT) {
4796 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 -07004797 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004798 "vkCreateImageView() If image was created with usage containing "
4799 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4800 }
4801 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004802 }
4803 return skip;
4804}
4805
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004806static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4807 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4808 const VkBufferCopy *pRegions) {
4809 bool skip = false;
4810
4811 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4812 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4813 VkDeviceSize src_min = UINT64_MAX;
4814 VkDeviceSize src_max = 0;
4815 VkDeviceSize dst_min = UINT64_MAX;
4816 VkDeviceSize dst_max = 0;
4817
4818 for (uint32_t i = 0; i < regionCount; i++) {
4819 src_min = std::min(src_min, pRegions[i].srcOffset);
4820 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4821 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4822 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4823
4824 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4825 if (pRegions[i].srcOffset >= src_buffer_size) {
4826 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4827 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4828 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4829 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4830 i, pRegions[i].srcOffset, i, pRegions[i].size);
4831 }
4832
4833 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4834 if (pRegions[i].dstOffset >= dst_buffer_size) {
4835 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4836 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4837 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4838 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4839 i, pRegions[i].dstOffset, i, pRegions[i].size);
4840 }
4841
4842 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4843 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4844 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4845 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4846 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4847 ") is greater than the source buffer size (%" PRIuLEAST64
4848 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4849 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4850 }
4851
4852 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4853 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4854 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4855 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4856 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4857 ") is greater than the destination buffer size (%" PRIuLEAST64
4858 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4859 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4860 }
4861 }
4862
4863 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4864 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4865 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4866 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4867 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4868 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4869 }
4870 }
4871
4872 return skip;
4873}
4874
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004875bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004876 uint32_t regionCount, const VkBufferCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004877 const auto cb_node = GetCBState(commandBuffer);
4878 const auto src_buffer_state = GetBufferState(srcBuffer);
4879 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004880
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004881 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004882 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4883 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004884 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004885 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004886 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4887 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004888 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004889 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4890 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004891 skip |=
4892 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4893 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004894 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4895 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004896 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004897 return skip;
4898}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004899
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004900bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) const {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004901 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004902 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004903 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004904 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 -06004905 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004906 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004907 } else {
4908 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004909 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 -06004910 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004911 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004912 }
4913 }
4914 return skip;
4915}
4916
Jeff Bolz5c801d12019-10-09 10:38:45 -05004917bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView,
4918 const VkAllocationCallbacks *pAllocator) const {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004919 const IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004920 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004921
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004922 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004923 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004924 skip |=
4925 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004926 }
4927 return skip;
4928}
4929
Jeff Bolz5c801d12019-10-09 10:38:45 -05004930bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004931 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004932
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004933 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004934 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004935 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004936 }
4937 return skip;
4938}
4939
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004940bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004941 const VkAllocationCallbacks *pAllocator) const {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004942 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004943 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004944 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004945 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004946 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004947 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004948 }
4949 return skip;
4950}
4951
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004952bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004953 VkDeviceSize size, uint32_t data) const {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004954 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004955 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004956 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004957 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004958 skip |=
4959 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4960 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004961 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004962 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004963 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4964 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004965 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinski693fbfd2019-12-03 16:06:30 -07004966
4967 if (dstOffset >= buffer_state->createInfo.size) {
4968 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4969 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-dstOffset-00024",
4970 "vkCmdFillBuffer(): dstOffset (0x%" PRIxLEAST64
4971 ") is not less than destination buffer (%s) size (0x%" PRIxLEAST64 ").",
4972 dstOffset, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size);
4973 }
4974
4975 if ((size != VK_WHOLE_SIZE) && (size > (buffer_state->createInfo.size - dstOffset))) {
4976 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4977 HandleToUint64(dstBuffer), "VUID-vkCmdFillBuffer-size-00027",
4978 "vkCmdFillBuffer(): size (0x%" PRIxLEAST64 ") is greater than dstBuffer (%s) size (0x%" PRIxLEAST64
4979 ") minus dstOffset (0x%" PRIxLEAST64 ").",
4980 size, report_data->FormatHandle(dstBuffer).c_str(), buffer_state->createInfo.size, dstOffset);
4981 }
4982
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004983 return skip;
4984}
4985
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004986bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions,
4987 const IMAGE_STATE *image_state, const char *function) const {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004988 bool skip = false;
4989
4990 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004991 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4992 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004993 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 -06004994 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004995 "%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 -06004996 "and 1, respectively.",
4997 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004998 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004999 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005000
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005001 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
5002 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005003 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 -06005004 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005005 "%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 -06005006 "must be 0 and 1, respectively.",
5007 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005008 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005009 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005010
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005011 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
5012 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005013 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 -06005014 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005015 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
5016 "For 3D images these must be 0 and 1, respectively.",
5017 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005018 }
5019 }
5020
5021 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07005022 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07005023 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
5024
Dave Houltona585d132019-01-18 13:05:42 -07005025 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005026 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 -06005027 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005028 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005029 " must be a multiple of this format's texel size (%" PRIu32 ").",
5030 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005031 }
5032
5033 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06005034 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005035 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 -06005036 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005037 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
5038 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005039 }
5040
5041 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
5042 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005043 skip |=
5044 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005045 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005046 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
5047 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005048 }
5049
5050 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
5051 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
5052 skip |= log_msg(
5053 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005054 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005055 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
5056 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005057 }
5058
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06005059 // Calculate adjusted image extent, accounting for multiplane image factors
5060 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
5061 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
5062 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
5063 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
5064 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5065 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
5066 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
5067 "zero or <= image subresource width (%d).",
5068 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
5069 adusted_image_extent.width);
5070 }
5071
5072 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
5073 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
5074 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
5075 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5076 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
5077 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
5078 "zero or <= image subresource height (%d).",
5079 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
5080 adusted_image_extent.height);
5081 }
5082
5083 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
5084 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
5085 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
5086 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5087 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
5088 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
5089 "zero or <= image subresource depth (%d).",
5090 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
5091 adusted_image_extent.depth);
5092 }
5093
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005094 // subresource aspectMask must have exactly 1 bit set
5095 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
5096 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
5097 if (aspect_mask_bits.count() != 1) {
5098 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 -06005099 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005100 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005101 }
5102
5103 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06005104 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005105 skip |= log_msg(
5106 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005107 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005108 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
5109 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005110 }
5111
5112 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04005113 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005114 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005115
5116 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06005117 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005118 skip |= log_msg(
5119 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-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005121 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
5122 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005123 }
5124
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005125 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005126 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07005127 skip |= log_msg(
5128 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-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005130 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
5131 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005132 }
5133
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005134 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06005135 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
5136 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
5137 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005138 skip |=
5139 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005140 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005141 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
5142 "width & height (%d, %d)..",
5143 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005144 }
5145
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005146 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07005147 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06005148 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005149 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 -06005150 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005151 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07005152 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005153 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005154 }
Dave Houlton67e9b532017-03-02 17:00:10 -07005155
5156 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07005157 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06005158 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005159 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
5160 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 -06005161 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07005162 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005163 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005164 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005165 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07005166 }
5167
5168 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06005169 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005170 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
5171 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 -06005172 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07005173 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005174 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005175 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005176 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07005177 }
5178
5179 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06005180 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07005181 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
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-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005184 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005185 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005186 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005187 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005188 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005189 }
sfricke-samsung552d5e12020-01-07 22:00:20 -08005190
5191 // Checks that apply only to multi-planar format images
5192 if (FormatIsMultiplane(image_state->createInfo.format)) {
5193 // VK_IMAGE_ASPECT_PLANE_2_BIT valid only for image formats with three planes
5194 if ((FormatPlaneCount(image_state->createInfo.format) < 3) &&
5195 (pRegions[i].imageSubresource.aspectMask == VK_IMAGE_ASPECT_PLANE_2_BIT)) {
5196 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5197 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5198 "%s(): pRegion[%d] subresource aspectMask cannot be VK_IMAGE_ASPECT_PLANE_2_BIT unless image "
5199 "format has three planes.",
5200 function, i);
5201 }
5202
5203 // image subresource aspectMask must be VK_IMAGE_ASPECT_PLANE_*_BIT
5204 if (0 == (pRegions[i].imageSubresource.aspectMask &
5205 (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT))) {
5206 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5207 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-01560",
5208 "%s(): pRegion[%d] subresource aspectMask for multi-plane image formats must have a "
5209 "VK_IMAGE_ASPECT_PLANE_*_BIT when copying to or from.",
5210 function, i);
5211 }
5212 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005213 }
5214
5215 return skip;
5216}
5217
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005218static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005219 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005220 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005221 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005222
5223 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005224 VkExtent3D extent = pRegions[i].imageExtent;
5225 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005226
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005227 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5228 {
Dave Houlton51653902018-06-22 17:32:13 -06005229 skip |=
5230 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5231 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5232 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005233 }
5234
5235 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5236
5237 // 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 -06005238 if (FormatIsCompressed(image_info->format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005239 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005240 if (image_extent.width % block_extent.width) {
5241 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5242 }
5243 if (image_extent.height % block_extent.height) {
5244 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5245 }
5246 if (image_extent.depth % block_extent.depth) {
5247 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5248 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005249 }
5250
Dave Houltonfc1a4052017-04-27 14:32:45 -06005251 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005252 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 -06005253 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005254 }
5255 }
5256
5257 return skip;
5258}
5259
Jeff Bolz46c0ea02019-10-09 13:06:29 -05005260static inline bool ValidateBufferBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state,
5261 const BUFFER_STATE *buff_state, uint32_t regionCount, const VkBufferImageCopy *pRegions,
5262 const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005263 bool skip = false;
5264
5265 VkDeviceSize buffer_size = buff_state->createInfo.size;
5266
5267 for (uint32_t i = 0; i < regionCount; i++) {
5268 VkExtent3D copy_extent = pRegions[i].imageExtent;
5269
5270 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5271 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005272 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5273 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005274
Tom Cooperb2550c72018-10-15 13:08:41 +01005275 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005276 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005277 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005278 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5279 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5280
5281 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5282 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5283 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005284 }
5285
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005286 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5287 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5288 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005289 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005290 } else {
5291 // Calculate buffer offset of final copied byte, + 1.
5292 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5293 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5294 max_buffer_offset *= unit_size; // convert to bytes
5295 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005296
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005297 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005298 skip |=
5299 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5300 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005301 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005302 }
5303 }
5304
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005305 return skip;
5306}
5307
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005308bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005309 VkBuffer dstBuffer, uint32_t regionCount,
5310 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005311 const auto cb_node = GetCBState(commandBuffer);
5312 const auto src_image_state = GetImageState(srcImage);
5313 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005314
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005315 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005316
5317 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005318 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005319
5320 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005321 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005322
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005323 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005324
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005325 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5326 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 -06005327 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005328 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005329 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005330 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005331 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005332 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005333 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005334 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005335
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005336 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005337 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005338 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5339 skip |=
5340 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005341
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005342 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005343 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005344 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5345 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005346 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005347 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5348 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005349 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005350 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5351 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005352 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005353 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005354 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005355 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005356 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5357 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5358 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005359 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005360 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005361 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005362 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005363 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5364 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005365 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5366 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5367 skip |=
5368 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5369 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5370 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005371 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5372 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005373 }
5374 return skip;
5375}
5376
John Zulauf1686f232019-07-09 16:27:11 -06005377void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5378 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5379 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5380
5381 auto cb_node = GetCBState(commandBuffer);
5382 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005383 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005384 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005385 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005386 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005387}
5388
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005389bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5390 VkImageLayout dstImageLayout, uint32_t regionCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005391 const VkBufferImageCopy *pRegions) const {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005392 const auto cb_node = GetCBState(commandBuffer);
5393 const auto src_buffer_state = GetBufferState(srcBuffer);
5394 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005395
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005396 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005397
5398 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005399 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005400
5401 // Command pool must support graphics, compute, or transfer operations
Jeff Bolz6835fda2019-10-06 00:15:34 -05005402 const auto pPool = cb_node->command_pool.get();
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005403 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005404 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5405 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 -06005406 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005407 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005408 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005409 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005410 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005411 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005412 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005413 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005414 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005415 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005416 skip |=
5417 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5418 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005419 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005420 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5421 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005422 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005423 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5424 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005425 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005426 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5427 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005428 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005429 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005430 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005431 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005432 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5433 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5434 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005435 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005436 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005437 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005438 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005439 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5440 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005441 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5442 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5443 skip |=
5444 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5445 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5446 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005447 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5448 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005449 }
5450 return skip;
5451}
5452
John Zulauf1686f232019-07-09 16:27:11 -06005453void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5454 VkImageLayout dstImageLayout, uint32_t regionCount,
5455 const VkBufferImageCopy *pRegions) {
5456 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5457
5458 auto cb_node = GetCBState(commandBuffer);
5459 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005460 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005461 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005462 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005463 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005464}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005465
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005466bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
Jeff Bolz5c801d12019-10-09 10:38:45 -05005467 VkSubresourceLayout *pLayout) const {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005468 bool skip = false;
5469 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5470
Dave Houlton1d960ff2018-01-19 12:17:05 -07005471 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005472 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5473 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5474 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005475 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 -06005476 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005477 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005478 }
5479
John Zulaufa26d3c82019-08-14 16:09:08 -06005480 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005481 if (!image_entry) {
5482 return skip;
5483 }
5484
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005485 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5486 if (device_extensions.vk_ext_image_drm_format_modifier) {
5487 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5488 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5489 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5490 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5491 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5492 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5493 }
5494 } else {
5495 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5496 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5497 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5498 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5499 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005500 }
5501
Dave Houlton1d960ff2018-01-19 12:17:05 -07005502 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005503 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005504 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5505 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5506 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5507 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005508 }
5509
Dave Houlton1d960ff2018-01-19 12:17:05 -07005510 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005511 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5513 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5514 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5515 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005516 }
5517
Dave Houlton1d960ff2018-01-19 12:17:05 -07005518 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005519 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005520 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5521 if (FormatIsMultiplane(img_format)) {
5522 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5523 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5524 if (FormatPlaneCount(img_format) > 2u) {
5525 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5526 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5527 }
5528 if (sub_aspect != (sub_aspect & allowed_flags)) {
5529 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5530 HandleToUint64(image), vuid,
5531 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5532 ") must be a single-plane specifier flag.",
5533 sub_aspect);
5534 }
5535 } else if (FormatIsColor(img_format)) {
5536 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5537 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5538 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5539 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5540 "VK_IMAGE_ASPECT_COLOR.");
5541 }
5542 } else if (FormatIsDepthOrStencil(img_format)) {
5543 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5544 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005545 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005546 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5547 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5548 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5549 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005550 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 -06005551 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5552 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5553 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005554 }
5555 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005556
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005557 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005558 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005559 }
5560
Mike Weiblen672b58b2017-02-21 14:32:53 -07005561 return skip;
5562}