blob: 381c40ea4d3d2d8771f1abe7ea844a9904c1a8a9 [file] [log] [blame]
Jeff Bolz87697532019-01-11 22:54:00 -06001/* Copyright (c) 2015-2019 The Khronos Group Inc.
2 * Copyright (c) 2015-2019 Valve Corporation
3 * Copyright (c) 2015-2019 LunarG, Inc.
4 * Copyright (C) 2015-2019 Google Inc.
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -07005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Mark Lobodzinski <mark@lunarg.com>
Dave Houlton4eaaf3a2017-03-14 11:31:20 -060019 * Author: Dave Houlton <daveh@lunarg.com>
Shannon McPherson3ea65132018-12-05 10:37:39 -070020 * Shannon McPherson <shannon@lunarg.com>
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070021 */
22
23// Allow use of STL min and max functions in Windows
24#define NOMINMAX
25
Dave Houlton0d4ad6f2018-09-05 14:53:34 -060026#include <cmath>
27#include <set>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070028#include <sstream>
Petr Kraus4d718682017-05-18 03:38:41 +020029#include <string>
Mark Lobodzinski90224de2017-01-26 15:23:11 -070030
31#include "vk_enum_string_helper.h"
Petr Kraus5a01b472019-08-10 01:40:28 +020032#include "vk_format_utils.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070033#include "vk_layer_data.h"
34#include "vk_layer_utils.h"
35#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060036#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070037
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070038#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070039#include "core_validation.h"
40#include "shader_validation.h"
41#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070042#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070043
John Zulauff660ad62019-03-23 07:16:05 -060044// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
45static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
46 VkImageSubresourceRange subresource_range;
47 subresource_range.aspectMask = subresource_layers.aspectMask;
48 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
49 subresource_range.layerCount = subresource_layers.layerCount;
50 subresource_range.baseMipLevel = subresource_layers.mipLevel;
51 subresource_range.levelCount = 1;
52 return subresource_range;
53}
54
55IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
56 : image(img),
57 createInfo(*pCreateInfo),
58 valid(false),
59 acquired(false),
60 shared_presentable(false),
61 layout_locked(false),
62 get_sparse_reqs_called(false),
63 sparse_metadata_required(false),
64 sparse_metadata_bound(false),
65 imported_ahb(false),
66 has_ahb_format(false),
67 ahb_format(0),
68 full_range{},
unknown09edc722019-06-21 15:49:38 -060069 create_from_swapchain(VK_NULL_HANDLE),
70 bind_swapchain(VK_NULL_HANDLE),
unknown08c57af2019-06-21 16:33:35 -060071 bind_swapchain_imageIndex(0),
72 sparse_requirements{} {
John Zulauff660ad62019-03-23 07:16:05 -060073 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
74 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
75 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
76 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
77 }
78 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
79 }
80
81 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
82 sparse = true;
83 }
84 const auto format = createInfo.format;
85 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
86 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
87 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
88 } else {
89 init_range.aspectMask =
90 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
91 }
92 full_range = NormalizeSubresourceRange(*this, init_range);
Locked8af3732019-05-10 09:47:56 -060093
94#ifdef VK_USE_PLATFORM_ANDROID_KHR
95 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
96 if (external_format) {
97 external_format_android = external_format->externalFormat;
98 } else {
99 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
100 external_format_android = 0;
101 }
102#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -0600103}
104
unknown2c877272019-07-11 12:56:50 -0600105bool IMAGE_STATE::IsCreateInfoEqual(const VkImageCreateInfo &other_createInfo) const {
106 bool is_equal = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
107 is_equal = is_equal && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
108 is_equal = is_equal && IsMipLevelsEqual(other_createInfo) && IsArrayLayersEqual(other_createInfo);
109 is_equal = is_equal && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
110 is_equal = is_equal && IsExtentEqual(other_createInfo) && IsTilingEqual(other_createInfo);
111 is_equal = is_equal && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
112 return is_equal && IsQueueFamilyIndicesEqual(other_createInfo);
113}
114
Jeff Bolz82f854d2019-09-17 14:56:47 -0500115// Check image compatibility rules for VK_NV_dedicated_allocation_image_aliasing
116bool IMAGE_STATE::IsCreateInfoDedicatedAllocationImageAliasingCompatible(const VkImageCreateInfo &other_createInfo) const {
117 bool is_compatible = (createInfo.sType == other_createInfo.sType) && (createInfo.flags == other_createInfo.flags);
118 is_compatible = is_compatible && IsImageTypeEqual(other_createInfo) && IsFormatEqual(other_createInfo);
119 is_compatible = is_compatible && IsMipLevelsEqual(other_createInfo);
120 is_compatible = is_compatible && IsUsageEqual(other_createInfo) && IsInitialLayoutEqual(other_createInfo);
121 is_compatible = is_compatible && IsSamplesEqual(other_createInfo) && IsSharingModeEqual(other_createInfo);
122 is_compatible = is_compatible && IsQueueFamilyIndicesEqual(other_createInfo) && IsTilingEqual(other_createInfo);
123
124 is_compatible = is_compatible && createInfo.extent.width <= other_createInfo.extent.width &&
125 createInfo.extent.height <= other_createInfo.extent.height &&
126 createInfo.extent.depth <= other_createInfo.extent.depth &&
127 createInfo.arrayLayers <= other_createInfo.arrayLayers;
128 return is_compatible;
129}
130
unknown2c877272019-07-11 12:56:50 -0600131bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
132 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
133 if ((create_from_swapchain == VK_NULL_HANDLE) && (binding.mem == other_image_state->binding.mem) &&
134 (binding.mem != VK_NULL_HANDLE) && (binding.offset == other_image_state->binding.offset) &&
135 IsCreateInfoEqual(other_image_state->createInfo)) {
136 return true;
137 }
unknowne1661522019-07-11 13:04:18 -0600138 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
139 return true;
140 }
unknown2c877272019-07-11 12:56:50 -0600141 return false;
142}
143
John Zulauff660ad62019-03-23 07:16:05 -0600144IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
145 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
146 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
147 if (conversionInfo) samplerConversion = conversionInfo->conversion;
148 if (image_state) {
149 // A light normalization of the createInfo range
150 auto &sub_res_range = create_info.subresourceRange;
151 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
152 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
153
154 // Cache a full normalization (for "full image/whole image" comparisons)
155 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500156 samples = image_state->createInfo.samples;
157 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600158 }
159}
160
Dave Houltond9611312018-11-19 17:03:36 -0700161uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
162 // uint cast applies floor()
163 return 1u + (uint32_t)log2(std::max({height, width, depth}));
164}
165
166uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
167
168uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
169
John Zulauff660ad62019-03-23 07:16:05 -0600170VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
171 const VkImageCreateInfo &image_create_info = image_state.createInfo;
172 VkImageSubresourceRange norm = range;
173 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
174
175 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
176 // <arrayLayers> can potentially alias.
177 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
178 ? image_create_info.extent.depth
179 : image_create_info.arrayLayers;
180 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
181
182 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
183 VkImageAspectFlags &aspect_mask = norm.aspectMask;
184 if (FormatIsMultiplane(image_create_info.format)) {
185 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
186 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
187 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
188 if (FormatPlaneCount(image_create_info.format) > 2) {
189 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
190 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700191 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700192 }
John Zulauff660ad62019-03-23 07:16:05 -0600193 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700194}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700195
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700196template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700197void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700198 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700199 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
200 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
201 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
202 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600203 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700204 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
205 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
206 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700207 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208}
209
210template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700211void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700212 if (imgpair.subresource.aspectMask & aspectMask) {
213 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700214 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700215 }
216}
217
Tony Barbourdf013b92017-01-25 12:53:48 -0700218// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600219void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700220 auto it = imageLayoutMap.find(imgpair);
221 if (it != imageLayoutMap.end()) {
222 it->second.layout = layout; // Update
223 } else {
224 imageLayoutMap[imgpair].layout = layout; // Insert
225 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700226}
227
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700228bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700229 if (!(imgpair.subresource.aspectMask & aspectMask)) {
230 return false;
231 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700232 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
233 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600234 auto imgsubIt = imageLayoutMap.find(imgpair);
235 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700236 return false;
237 }
238 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200239 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 -0600240 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600241 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700242 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700243 string_VkImageLayout(imgsubIt->second.layout));
244 }
245 layout = imgsubIt->second.layout;
246 return true;
247}
248
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700249// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700250bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700251 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700252 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
253 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
254 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
255 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600256 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700257 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
258 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
259 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700260 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700261 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
262 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600263 auto imgsubIt = imageLayoutMap.find(imgpair);
264 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700265 layout = imgsubIt->second.layout;
266 }
267 return true;
268}
269
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700270bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600271 auto sub_data = imageSubresourceMap.find(image);
272 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700273 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700274 if (!image_state) return false;
275 bool ignoreGlobal = false;
276 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
277 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
278 ignoreGlobal = true;
279 }
280 for (auto imgsubpair : sub_data->second) {
281 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600282 auto img_data = imageLayoutMap.find(imgsubpair);
283 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700284 layouts.push_back(img_data->second.layout);
285 }
286 }
287 return true;
288}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700289
John Zulauf3b04ebd2019-07-18 14:08:11 -0600290bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
291 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700292 if (!(imgpair.subresource.aspectMask & aspectMask)) {
293 return false;
294 }
295 imgpair.subresource.aspectMask = aspectMask;
296 auto imgsubIt = imageLayoutMap.find(imgpair);
297 if (imgsubIt == imageLayoutMap.end()) {
298 return false;
299 }
300 layout = imgsubIt->second.layout;
301 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700302}
Tony Barbourdf013b92017-01-25 12:53:48 -0700303
304// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600305bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
306 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700307 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
308 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
309 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
310 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
311 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600312 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700313 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
314 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
315 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
316 }
317 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700318 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
319 imgpair = {imgpair.image, false, VkImageSubresource()};
320 auto imgsubIt = imageLayoutMap.find(imgpair);
321 if (imgsubIt == imageLayoutMap.end()) return false;
322 layout = imgsubIt->second.layout;
323 }
324 return true;
325}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700326
327// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700328void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700329 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600330 auto data = imageLayoutMap.find(imgpair);
331 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700332 data->second.layout = layout; // Update
333 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600334 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700335 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600336 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700337 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
338 if (subresource == image_subresources.end()) {
339 image_subresources.push_back(imgpair);
340 }
341}
342
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600343// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600344void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600345 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
346 VkImageLayout expected_layout) {
347 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
348 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600349 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600350 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700351 }
352}
John Zulauff660ad62019-03-23 07:16:05 -0600353
354// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600355void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500356 if (disabled.image_layout_validation) {
357 return;
358 }
John Zulauff660ad62019-03-23 07:16:05 -0600359 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
360 if (image_state) {
361 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600362 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600363 }
364}
365
366// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600367void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600368 const VkImageSubresourceRange &range, VkImageLayout layout) {
369 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
370 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600371 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600372}
373
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600374void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600375 VkImageLayout layout) {
376 const IMAGE_STATE *image_state = GetImageState(image);
377 if (!image_state) return;
378 SetImageInitialLayout(cb_node, *image_state, range, layout);
379};
380
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600381void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600382 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
383 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600384}
Dave Houltonddd65c52018-05-08 14:58:01 -0600385
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600386// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600387void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600388 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
389 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600390
John Zulauff660ad62019-03-23 07:16:05 -0600391 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600392 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
393 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600394 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 -0600395 sub_range.baseArrayLayer = 0;
396 sub_range.layerCount = image_state->createInfo.extent.depth;
397 }
398
John Zulauff660ad62019-03-23 07:16:05 -0600399 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600400}
401
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700402bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
403 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700404 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600405 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100406 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700407 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100408 const char *vuid;
409 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
410
411 if (!image_state) {
412 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
413 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600414 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700415 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
416 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100417 return skip;
418 }
419
420 auto image_usage = image_state->createInfo.usage;
421
422 // Check for layouts that mismatch image usages in the framebuffer
423 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
424 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
425 skip |=
426 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 -0600427 "Layout/usage mismatch for attachment %u in %s"
428 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100429 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600430 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
431 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100432 }
433
434 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
435 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
436 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
437 skip |=
438 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 -0600439 "Layout/usage mismatch for attachment %u in %s"
440 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600442 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
443 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100444 }
445
446 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
447 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
448 skip |=
449 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 -0600450 "Layout/usage mismatch for attachment %u in %s"
451 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600453 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
454 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 }
456
457 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
458 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
459 skip |=
460 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 -0600461 "Layout/usage mismatch for attachment %u in %s"
462 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100463 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600464 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
465 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100466 }
467
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600468 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100469 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
470 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
471 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
472 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
473 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
474 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700475 skip |= log_msg(
476 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 -0600477 "Layout/usage mismatch for attachment %u in %s"
478 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700479 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600480 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
481 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100482 }
483 } else {
484 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
485 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
486 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
487 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
488 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
489 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600490 "Layout/usage mismatch for attachment %u in %s"
491 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100492 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600493 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
494 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700495 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100496 }
497 }
498 return skip;
499}
500
John Zulauf17a01bb2019-08-09 16:41:19 -0600501bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700502 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600503 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600504 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700505 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700506 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100508
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700509 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100510 auto framebuffer = framebuffer_state->framebuffer;
511
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700512 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600513 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 -0600514 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700515 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700516 }
John Zulauf8e308292018-09-21 11:34:37 -0600517
Tobias Hectorc9057422019-07-23 12:15:52 +0100518 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
519 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
520 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100521 }
522
Tobias Hectorc9057422019-07-23 12:15:52 +0100523 if (attachments != nullptr) {
524 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
525 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
526 auto image_view = attachments[i];
527 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100528
Tobias Hectorc9057422019-07-23 12:15:52 +0100529 if (!view_state) {
530 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
531 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
532 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
533 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
534 report_data->FormatHandle(image_view).c_str());
535 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100536 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100537
538 const VkImage image = view_state->create_info.image;
539 const IMAGE_STATE *image_state = GetImageState(image);
540
541 if (!image_state) {
542 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
543 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
544 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
545 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
546 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
547 continue;
548 }
549 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
550 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
551
552 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
553 // in common with the non-const version.)
554 const ImageSubresourceLayoutMap *subresource_map =
555 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
556
557 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
558 LayoutUseCheckAndMessage layout_check(subresource_map);
559 bool subres_skip = false;
560 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
561 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
562 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
563 subres_skip |=
564 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
565 kVUID_Core_DrawState_InvalidRenderpass,
566 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
567 "and the %s layout of the attachment is %s. The layouts must match, or the render "
568 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
569 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
570 string_VkImageLayout(layout_check.layout));
571 }
572 return !subres_skip; // quit checking subresources once we fail once
573 };
574
575 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
576 skip |= subres_skip;
577 }
578
579 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
580 framebuffer, render_pass, i, "initial layout");
581
582 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
583 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100584 }
585
Tobias Hectorc9057422019-07-23 12:15:52 +0100586 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
587 auto &subpass = pRenderPassInfo->pSubpasses[j];
588 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
589 auto &attachment_ref = subpass.pInputAttachments[k];
590 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
591 auto image_view = attachments[attachment_ref.attachment];
592 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100593
Tobias Hectorc9057422019-07-23 12:15:52 +0100594 if (view_state) {
595 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700596 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
597 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100598 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100599 }
600 }
601 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100602
Tobias Hectorc9057422019-07-23 12:15:52 +0100603 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
604 auto &attachment_ref = subpass.pColorAttachments[k];
605 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
606 auto image_view = attachments[attachment_ref.attachment];
607 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100608
Tobias Hectorc9057422019-07-23 12:15:52 +0100609 if (view_state) {
610 auto image = view_state->create_info.image;
611 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
612 framebuffer, render_pass, attachment_ref.attachment,
613 "color attachment layout");
614 if (subpass.pResolveAttachments) {
615 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
616 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
617 attachment_ref.attachment, "resolve attachment layout");
618 }
619 }
620 }
621 }
622
623 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
624 auto &attachment_ref = *subpass.pDepthStencilAttachment;
625 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
626 auto image_view = attachments[attachment_ref.attachment];
627 auto view_state = GetImageViewState(image_view);
628
629 if (view_state) {
630 auto image = view_state->create_info.image;
631 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
632 framebuffer, render_pass, attachment_ref.attachment,
633 "input attachment layout");
634 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100635 }
636 }
637 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700638 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600639 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700640}
641
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600642void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700643 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700644 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700645 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600646 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600647 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600648 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700649 }
650}
651
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600652void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
653 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700654 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700655
656 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700657 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700658 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700659 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700660 }
661 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700662 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700663 }
664 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700665 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700666 }
667 }
668}
669
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700670// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
671// 1. Transition into initialLayout state
672// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600673void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700674 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700675 // First transition into initialLayout
676 auto const rpci = render_pass_state->createInfo.ptr();
677 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700678 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600679 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600680 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600681 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700682 }
683 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700684 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700685}
686
Dave Houlton10b39482017-03-16 13:18:15 -0600687bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600688 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600689 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600690 }
691 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600692 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600693 }
694 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600695 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600696 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700697 if (0 !=
698 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
699 if (FormatPlaneCount(format) == 1) return false;
700 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600701 return true;
702}
703
Mike Weiblen62d08a32017-03-07 22:18:27 -0700704// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200705bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
706 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600707 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700708 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200709 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600710 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700711
712 switch (layout) {
713 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
714 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600715 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700716 }
717 break;
718 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
719 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600720 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700721 }
722 break;
723 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
724 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600725 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700726 }
727 break;
728 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
729 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600730 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700731 }
732 break;
733 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
734 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600735 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700736 }
737 break;
738 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
739 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600740 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700741 }
742 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600743 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500744 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
745 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
746 }
747 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700748 default:
749 // Other VkImageLayout values do not have VUs defined in this context.
750 break;
751 }
752
Dave Houlton8e9f6542018-05-18 12:18:22 -0600753 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600754 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 +0200755 HandleToUint64(img_barrier.image), msg_code,
756 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
757 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
758 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700759 }
760 return skip;
761}
762
763// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600764bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
765 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700766 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700767
Petr Krausad0096a2019-08-09 18:35:04 +0200768 // Scoreboard for checking for duplicate and inconsistent barriers to images
769 struct ImageBarrierScoreboardEntry {
770 uint32_t index;
771 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
772 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
773 const VkImageMemoryBarrier *barrier;
774 };
775 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
776 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
777
John Zulauf463c51e2018-05-31 13:29:20 -0600778 // Scoreboard for duplicate layout transition barriers within the list
779 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
780 ImageBarrierScoreboardImageMap layout_transitions;
781
Mike Weiblen62d08a32017-03-07 22:18:27 -0700782 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200783 const auto &img_barrier = pImageMemoryBarriers[i];
784 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700785
John Zulauf463c51e2018-05-31 13:29:20 -0600786 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
787 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
788 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200789 if (img_barrier.oldLayout != img_barrier.newLayout) {
790 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
791 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600792 if (image_it != layout_transitions.end()) {
793 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200794 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600795 if (subres_it != subres_map.end()) {
796 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200797 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
798 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
799 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600800 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700801 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
802 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200803 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600804 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
805 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200806 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
807 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
808 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600809 }
810 entry = new_entry;
811 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200812 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600813 }
814 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200815 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600816 }
817 }
818
Petr Krausad0096a2019-08-09 18:35:04 +0200819 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600820 if (image_state) {
821 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200822 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
823 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600824
825 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
826 if (image_state->layout_locked) {
827 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600828 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700829 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200830 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600831 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600832 " 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 +0200833 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
834 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600835 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600836
John Zulaufa4472282019-08-22 14:44:34 -0600837 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600838 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600839 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200840 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600841 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
842 if ((aspect_mask & ds_mask) != (ds_mask)) {
843 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 +0200844 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-01207",
845 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600846 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200847 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600848 string_VkFormat(image_create_info.format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700849 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700850 }
John Zulauff660ad62019-03-23 07:16:05 -0600851
Petr Krausad0096a2019-08-09 18:35:04 +0200852 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
853 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600854 // TODO: Set memory invalid which is in mem_tracker currently
855 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
856 // subresource.
857 } else if (subresource_map) {
858 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600859 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200860 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600861 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600862 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200863 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600864 subres_skip =
865 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
866 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600867 "For %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
John Zulauff660ad62019-03-23 07:16:05 -0600868 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200869 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
870 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600871 string_VkImageLayout(layout_check.layout));
872 }
873 return !subres_skip;
874 };
875 subresource_map->ForRange(normalized_isr, subres_callback);
876 skip |= subres_skip;
877 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700878 }
879 }
880 return skip;
881}
882
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600883bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200884 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700885
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600886 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
Petr Krausad0096a2019-08-09 18:35:04 +0200887 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700888}
889
John Zulauf6b4aae82018-05-09 13:03:36 -0600890template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600891bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
892 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600893 using BarrierRecord = QFOTransferBarrier<Barrier>;
894 bool skip = false;
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600895 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600896 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
897 const char *barrier_name = BarrierRecord::BarrierName();
898 const char *handle_name = BarrierRecord::HandleName();
899 const char *transfer_type = nullptr;
900 for (uint32_t b = 0; b < barrier_count; b++) {
901 if (!IsTransferOp(&barriers[b])) continue;
902 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700903 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600904 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600905 const auto found = barrier_sets.release.find(barriers[b]);
906 if (found != barrier_sets.release.cend()) {
907 barrier_record = &(*found);
908 transfer_type = "releasing";
909 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600910 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600911 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600912 const auto found = barrier_sets.acquire.find(barriers[b]);
913 if (found != barrier_sets.acquire.cend()) {
914 barrier_record = &(*found);
915 transfer_type = "acquiring";
916 }
917 }
918 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700919 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
920 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
921 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
922 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
923 func_name, barrier_name, b, transfer_type, handle_name,
924 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
925 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600926 }
927 }
928 return skip;
929}
930
John Zulaufa4472282019-08-22 14:44:34 -0600931VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
932 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
933}
934
935const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
936 return device_state.GetImageState(barrier.image);
937}
938
939VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
940 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
941}
942
943const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
944 return device_state.GetBufferState(barrier.buffer);
945}
946
947VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
948
John Zulauf6b4aae82018-05-09 13:03:36 -0600949template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600950void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
951 const Barrier *barriers) {
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600952 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600953 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
954 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600955 auto &barrier = barriers[b];
956 if (IsTransferOp(&barrier)) {
957 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
958 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
959 barrier_sets.release.emplace(barrier);
960 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
961 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
962 barrier_sets.acquire.emplace(barrier);
963 }
964 }
965
966 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
967 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
968 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
969 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
970 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
971 auto handle_state = BarrierHandleState(*this, barrier);
972 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
973 if (!mode_concurrent) {
974 const auto typed_handle = BarrierTypedHandle(barrier);
975 cb_state->eventUpdates.emplace_back(
976 [this, func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](VkQueue queue) {
977 return ValidateConcurrentBarrierAtSubmit(queue, func_name, cb_state, typed_handle, src_queue_family,
978 dst_queue_family);
979 });
980 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600981 }
982 }
983}
984
John Zulaufa4472282019-08-22 14:44:34 -0600985bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600986 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700987 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600988 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600989 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700990 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
991 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600992 return skip;
993}
994
John Zulaufa4472282019-08-22 14:44:34 -0600995void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
996 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
997 const VkImageMemoryBarrier *pImageMemBarriers) {
998 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
999 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -06001000}
1001
1002template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001003bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001004 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001005 // Record to the scoreboard or report that we have a duplication
1006 bool skip = false;
1007 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
1008 if (!inserted.second && inserted.first->second != cb_state) {
1009 // 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 -07001010 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1011 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
1012 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -06001013 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -07001014 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
1015 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001016 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001017 }
1018 return skip;
1019}
1020
1021template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001022bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1023 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001024 using BarrierRecord = QFOTransferBarrier<Barrier>;
1025 using TypeTag = typename BarrierRecord::Tag;
1026 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001027 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001028 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001029 const char *barrier_name = BarrierRecord::BarrierName();
1030 const char *handle_name = BarrierRecord::HandleName();
1031 // No release should have an extant duplicate (WARNING)
1032 for (const auto &release : cb_barriers.release) {
1033 // Check the global pending release barriers
1034 const auto set_it = global_release_barriers.find(release.handle);
1035 if (set_it != global_release_barriers.cend()) {
1036 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1037 const auto found = set_for_handle.find(release);
1038 if (found != set_for_handle.cend()) {
1039 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1040 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001041 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001042 " to dstQueueFamilyIndex %" PRIu32
1043 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001044 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001045 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1046 }
1047 }
1048 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1049 }
1050 // Each acquire must have a matching release (ERROR)
1051 for (const auto &acquire : cb_barriers.acquire) {
1052 const auto set_it = global_release_barriers.find(acquire.handle);
1053 bool matching_release_found = false;
1054 if (set_it != global_release_barriers.cend()) {
1055 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1056 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1057 }
1058 if (!matching_release_found) {
1059 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1060 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001061 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1062 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1063 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001064 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1065 }
1066 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1067 }
1068 return skip;
1069}
1070
John Zulauf3b04ebd2019-07-18 14:08:11 -06001071bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001072 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001073 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001074 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001075 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1076 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001077 return skip;
1078}
1079
1080template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001081void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001082 using BarrierRecord = QFOTransferBarrier<Barrier>;
1083 using TypeTag = typename BarrierRecord::Tag;
1084 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001085 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001086
1087 // Add release barriers from this submit to the global map
1088 for (const auto &release : cb_barriers.release) {
1089 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1090 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1091 global_release_barriers[release.handle].insert(release);
1092 }
1093
1094 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1095 for (const auto &acquire : cb_barriers.acquire) {
1096 // NOTE: We're not using [] because we don't want to create entries for missing releases
1097 auto set_it = global_release_barriers.find(acquire.handle);
1098 if (set_it != global_release_barriers.end()) {
1099 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1100 set_for_handle.erase(acquire);
1101 if (set_for_handle.size() == 0) { // Clean up empty sets
1102 global_release_barriers.erase(set_it);
1103 }
1104 }
1105 }
1106}
1107
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001108void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001109 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1110 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001111}
1112
John Zulauf6b4aae82018-05-09 13:03:36 -06001113// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001114void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001115
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001116void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001117 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001118 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001119 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001120
Chris Forbes4de4b132017-08-21 11:27:08 -07001121 // For ownership transfers, the barrier is specified twice; as a release
1122 // operation on the yielding queue family, and as an acquire operation
1123 // on the acquiring queue family. This barrier may also include a layout
1124 // transition, which occurs 'between' the two operations. For validation
1125 // purposes it doesn't seem important which side performs the layout
1126 // transition, but it must not be performed twice. We'll arbitrarily
1127 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001128 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001129 continue;
1130 }
1131
Petr Krausad0096a2019-08-09 18:35:04 +02001132 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001133 if (!image_state) continue;
unknown86bcb3a2019-07-11 13:05:36 -06001134 RecordTransitionImageLayout(cb_state, image_state, mem_barrier);
1135 for (const auto &image : image_state->aliasing_images) {
1136 image_state = GetImageState(image);
1137 RecordTransitionImageLayout(cb_state, image_state, mem_barrier);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001138 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001139 }
1140}
1141
unknown86bcb3a2019-07-11 13:05:36 -06001142void CoreChecks::RecordTransitionImageLayout(CMD_BUFFER_STATE *cb_state, const IMAGE_STATE *image_state,
1143 const VkImageMemoryBarrier &mem_barrier) {
1144 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
1145 const auto &image_create_info = image_state->createInfo;
1146
1147 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1148 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1149 // for all (potential) layer sub_resources.
1150 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1151 normalized_isr.baseArrayLayer = 0;
1152 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
1153 }
1154
1155 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
1156}
1157
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001158bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1159 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1160 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1161 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001162 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001163 assert(cb_node);
1164 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001165 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001166 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001167
John Zulauff660ad62019-03-23 07:16:05 -06001168 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1169 if (subresource_map) {
1170 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001171 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1172 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001173 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001174 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001175 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001176 subres_skip |=
1177 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1178 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001179 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001180 "%s layout %s.",
1181 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1182 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001183 }
John Zulauff660ad62019-03-23 07:16:05 -06001184 return !subres_skip;
1185 };
1186 subresource_map->ForRange(range, subresource_cb);
1187 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001188 }
John Zulauff660ad62019-03-23 07:16:05 -06001189
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001190 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1191 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1192 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001193 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1194 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001195 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001196 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001197 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001198 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001199 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001200 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001201 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001202 if (image_state->shared_presentable) {
1203 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1205 layout_invalid_msg_code,
1206 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1207 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001208 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001209 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001210 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001211 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001212 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 -07001213 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001214 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001215 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1216 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001217 }
1218 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001219 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001220}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001221bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001222 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1223 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001224 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001225 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1226 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1227}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001228
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001229void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001230 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001231 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001232 if (!renderPass) return;
1233
Tobias Hectorbbb12282018-10-22 15:17:59 +01001234 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001235 if (framebuffer_state) {
1236 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001237 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001238 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001239 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001240 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001241 }
1242 }
1243}
Dave Houltone19e20d2018-02-02 16:32:41 -07001244
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001245#ifdef VK_USE_PLATFORM_ANDROID_KHR
1246// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1247// This could also move into a seperate core_validation_android.cpp file... ?
1248
1249//
1250// AHB-specific validation within non-AHB APIs
1251//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001252bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001253 bool skip = false;
1254
1255 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1256 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001257 if (0 != ext_fmt_android->externalFormat) {
1258 if (VK_FORMAT_UNDEFINED != create_info->format) {
1259 skip |=
1260 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1261 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001262 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001263 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1264 }
1265
1266 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1267 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1268 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001269 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001270 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1271 }
1272
1273 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1275 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001276 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001277 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1278 }
1279
1280 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1281 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1282 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001283 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001284 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1285 }
1286 }
1287
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001288 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001289 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1290 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001291 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001292 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1293 }
1294 }
1295
Dave Houltond9611312018-11-19 17:03:36 -07001296 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001297 if (VK_FORMAT_UNDEFINED == create_info->format) {
1298 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1299 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001300 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001301 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1302 }
1303 }
1304
1305 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1306 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1307 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001308 skip |=
1309 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1310 "VUID-VkImageCreateInfo-pNext-02393",
1311 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1312 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1313 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001314 }
1315
1316 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1317 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1318 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001319 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001320 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1321 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1322 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1323 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001324 }
1325
1326 return skip;
1327}
1328
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001329bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001330 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001331 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001332
1333 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001334 if (VK_FORMAT_UNDEFINED != create_info->format) {
1335 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1336 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1337 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1338 "format member is %s.",
1339 string_VkFormat(create_info->format));
1340 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001341
Dave Houltond9611312018-11-19 17:03:36 -07001342 // Chain must include a compatible ycbcr conversion
1343 bool conv_found = false;
1344 uint64_t external_format = 0;
1345 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1346 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001347 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001348 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001349 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001350 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001351 }
Dave Houltond9611312018-11-19 17:03:36 -07001352 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001353 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001354 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 -07001355 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1356 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1357 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1358 }
1359
1360 // Errors in create_info swizzles
1361 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1362 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1363 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1364 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1366 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1367 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1368 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001369 }
1370 }
Dave Houltond9611312018-11-19 17:03:36 -07001371
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001372 return skip;
1373}
1374
John Zulaufa26d3c82019-08-14 16:09:08 -06001375bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001376 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001377
John Zulaufa26d3c82019-08-14 16:09:08 -06001378 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001379 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1380 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1381 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001382 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001383 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1384 "bound to memory.");
1385 }
1386 return skip;
1387}
1388
1389#else
1390
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001391bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001392 return false;
1393}
1394
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001395bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001396
John Zulaufa26d3c82019-08-14 16:09:08 -06001397bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001398
1399#endif // VK_USE_PLATFORM_ANDROID_KHR
1400
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001401bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1402 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001403 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001404
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001405 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001406 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001407 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1408 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1409 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1410 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001411 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001412 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001413 }
1414
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001415 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1416 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1417 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1418 "VUID-VkImageCreateInfo-flags-00949",
1419 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1420 "flag bit is set");
1421 }
1422
1423 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1424 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1425 "VUID-VkImageCreateInfo-imageType-00954",
1426 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1427 "height (%d) and arrayLayers (%d) must be >= 6.",
1428 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1429 }
Dave Houlton130c0212018-01-29 13:39:56 -07001430 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001431
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001432 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001433 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1434 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1435 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001436 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 +00001437 "VUID-VkImageCreateInfo-usage-00964",
1438 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1439 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001440 }
1441
1442 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001443 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 +00001444 "VUID-VkImageCreateInfo-usage-00965",
1445 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1446 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001447 }
1448
ByumjinConffx991b6062019-08-14 15:17:53 -07001449 if (device_extensions.vk_ext_fragment_density_map) {
1450 uint32_t ceiling_width =
1451 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1452 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1453 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1454 skip |=
1455 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1456 "VUID-VkImageCreateInfo-usage-02559",
1457 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1458 "ceiling of device "
1459 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1460 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1461 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1462 }
1463
1464 uint32_t ceiling_height =
1465 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1466 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1467 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1468 skip |=
1469 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1470 "VUID-VkImageCreateInfo-usage-02560",
1471 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1472 "ceiling of device "
1473 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1474 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1475 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1476 }
1477 }
1478
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001479 VkImageFormatProperties format_limits = {};
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001480 VkResult result = VK_SUCCESS;
1481 if (pCreateInfo->tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
1482 result = DispatchGetPhysicalDeviceImageFormatProperties(physical_device, pCreateInfo->format, pCreateInfo->imageType,
1483 pCreateInfo->tiling, pCreateInfo->usage, pCreateInfo->flags,
1484 &format_limits);
1485 } else {
1486 auto image_format_info = lvl_init_struct<VkPhysicalDeviceImageFormatInfo2>();
1487 auto image_format_properties = lvl_init_struct<VkImageFormatProperties2>();
1488 image_format_info.type = pCreateInfo->imageType;
1489 image_format_info.tiling = pCreateInfo->tiling;
1490 image_format_info.usage = pCreateInfo->usage;
1491 image_format_info.flags = pCreateInfo->flags;
1492 result = DispatchGetPhysicalDeviceImageFormatProperties2(physical_device, &image_format_info, &image_format_properties);
1493 format_limits = image_format_properties.imageFormatProperties;
1494 }
Mark Lobodzinski41dc7a82019-10-02 16:02:13 -06001495
Mark Lobodzinskib8d149f2019-10-02 16:42:32 -06001496 if (result == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001497#ifdef VK_USE_PLATFORM_ANDROID_KHR
1498 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1499#endif // VK_USE_PLATFORM_ANDROID_KHR
1500 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1501 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1502 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001503 } else {
1504 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1505 const char *format_string = string_VkFormat(pCreateInfo->format);
1506 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1507 "VUID-VkImageCreateInfo-mipLevels-02255",
1508 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1509 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1510 }
Dave Houlton130c0212018-01-29 13:39:56 -07001511
Dave Houltona585d132019-01-18 13:05:42 -07001512 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1513 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1514 (uint64_t)pCreateInfo->samples;
1515 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001516
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001517 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001518 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001519 uint64_t ig_mask = imageGranularity - 1;
1520 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001521
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001522 if (total_size > format_limits.maxResourceSize) {
1523 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1524 kVUID_Core_Image_InvalidFormatLimitsViolation,
1525 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1526 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1527 total_size, format_limits.maxResourceSize);
1528 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001529
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001530 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1531 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1532 "VUID-VkImageCreateInfo-arrayLayers-02256",
1533 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1534 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1535 }
1536
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001537 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1538 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001539 skip |= log_msg(
1540 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1541 "VUID-VkImageCreateInfo-format-02653",
1542 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1543 pCreateInfo->arrayLayers);
1544 }
1545
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001546 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1547 skip |=
1548 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1549 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001550 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001551 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001552 }
1553
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001554 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001555 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 -06001556 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001557 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1558 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001559 }
1560
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001561 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001562 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1563 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1564 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1565 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001566 skip |=
1567 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1568 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1569 "format must be block, ETC or ASTC compressed, but is %s",
1570 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001571 }
1572 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1573 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001574 skip |=
1575 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1576 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1577 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001578 }
1579 }
1580 }
1581
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001582 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001583 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1584 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1585 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001586 }
1587
unknown2c877272019-07-11 12:56:50 -06001588 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1589 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1590 skip |=
1591 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1592 "VUID-VkImageCreateInfo-format-01577",
1593 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1594 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1595 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001596 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001597}
1598
John Zulauf7eeb6f72019-06-17 11:56:36 -06001599void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1600 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1601 if (VK_SUCCESS != result) return;
1602
1603 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1604
1605 IMAGE_LAYOUT_STATE image_state;
1606 image_state.layout = pCreateInfo->initialLayout;
1607 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001608 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001609 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001610 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001611}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001612
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001613bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001614 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001615 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001616 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001617 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001618 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001619 }
1620 return skip;
1621}
1622
John Zulauf7eeb6f72019-06-17 11:56:36 -06001623void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1624 // Clean up validation specific data
1625 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001626
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001627 const auto &sub_entry = imageSubresourceMap.find(image);
1628 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001629 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001630 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001631 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001632 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001633 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001634
1635 // Clean up generic image state
1636 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001637}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001638
John Zulauf07288512019-07-05 11:09:50 -06001639bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001640 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001641
1642 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1643 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1644 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 -06001645 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001646 }
1647
Dave Houlton1d2022c2017-03-29 11:43:58 -06001648 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001649 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1650 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 -06001651 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001652 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001653 char const str[] = "vkCmdClearColorImage called with compressed image.";
1654 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 -06001655 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001656 }
1657
1658 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1659 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1660 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 -06001661 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001662 }
1663 return skip;
1664}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001665
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001666uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1667 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1668 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001669 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001670 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001671 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001672 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001673}
1674
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001675uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1676 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1677 uint32_t array_layer_count = range->layerCount;
1678 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1679 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001680 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001681 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001682}
1683
John Zulauf07288512019-07-05 11:09:50 -06001684bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1685 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1686 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001687 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001688
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001689 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1690 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001691 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1692 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001693 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06001694 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001695 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1696 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001697 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001698 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001699 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001700 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001701 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001702 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1703 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001704
1705 } else {
1706 if (image_state->shared_presentable) {
1707 skip |= log_msg(
1708 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001709 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001710 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1711 string_VkImageLayout(dest_image_layout));
1712 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001713 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001714 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001715 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001716 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001717 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001718 } else {
1719 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1720 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001721 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001722 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001723 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1724 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001725 }
1726 }
1727
John Zulauff660ad62019-03-23 07:16:05 -06001728 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001729 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001730 if (subresource_map) {
1731 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001732 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001733 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001734 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001735 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001736 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001737 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1738 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1739 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1740 } else {
1741 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001742 }
John Zulauff660ad62019-03-23 07:16:05 -06001743 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1744 HandleToUint64(cb_node->commandBuffer), error_code,
1745 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1746 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1747 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001748 }
John Zulauff660ad62019-03-23 07:16:05 -06001749 return !subres_skip;
1750 };
1751 subresource_map->ForRange(normalized_isr, subres_callback);
1752 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001753 }
1754
1755 return skip;
1756}
1757
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001758bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1759 const VkClearColorValue *pColor, uint32_t rangeCount,
1760 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001761 bool skip = false;
1762 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001763 const auto *cb_node = GetCBState(commandBuffer);
1764 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001765 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001766 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001767 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001768 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001769 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001770 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001771 skip |=
1772 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1773 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001774 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001775 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001776 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001777 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001778 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001779 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1780 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001781 }
1782 }
1783 return skip;
1784}
1785
John Zulaufeabb4462019-07-05 14:13:03 -06001786void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1787 const VkClearColorValue *pColor, uint32_t rangeCount,
1788 const VkImageSubresourceRange *pRanges) {
1789 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1790
1791 auto cb_node = GetCBState(commandBuffer);
1792 auto image_state = GetImageState(image);
1793 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001794 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001795 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001796 }
1797 }
1798}
1799
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001800bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1801 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1802 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001803 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001804
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001805 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001806 const auto *cb_node = GetCBState(commandBuffer);
1807 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001808 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001809 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001810 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001811 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001812 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001813 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001814 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001815 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1816 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001817 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001818 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001819 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001820 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001821 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001822 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001823 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001824 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001825 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1826 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001827 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001828 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1829 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001830 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 -06001831 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001832 }
1833 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001834 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001835 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001836 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 -06001837 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001838 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001839 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1840 char const str[] =
1841 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1842 "set.";
1843 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 -06001844 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001845 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001846 }
1847 return skip;
1848}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001849
John Zulaufeabb4462019-07-05 14:13:03 -06001850void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1851 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1852 const VkImageSubresourceRange *pRanges) {
1853 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1854 auto cb_node = GetCBState(commandBuffer);
1855 auto image_state = GetImageState(image);
1856 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001857 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001858 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001859 }
1860 }
1861}
1862
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001863// Returns true if [x, xoffset] and [y, yoffset] overlap
1864static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1865 bool result = false;
1866 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1867 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1868
1869 if (intersection_max > intersection_min) {
1870 result = true;
1871 }
1872 return result;
1873}
1874
Dave Houltonc991cc92018-03-06 11:08:51 -07001875// Returns true if source area of first copy region intersects dest area of second region
1876// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1877static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001878 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001879
Dave Houltonc991cc92018-03-06 11:08:51 -07001880 // Separate planes within a multiplane image cannot intersect
1881 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001882 return result;
1883 }
1884
Dave Houltonc991cc92018-03-06 11:08:51 -07001885 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1886 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1887 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001888 result = true;
1889 switch (type) {
1890 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001891 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001892 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001893 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001894 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001895 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001896 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001897 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001898 break;
1899 default:
1900 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1901 assert(false);
1902 }
1903 }
1904 return result;
1905}
1906
Dave Houltonfc1a4052017-04-27 14:32:45 -06001907// Returns non-zero if offset and extent exceed image extents
1908static const uint32_t x_bit = 1;
1909static const uint32_t y_bit = 2;
1910static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001911static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001912 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001913 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001914 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1915 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001916 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001917 }
1918 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1919 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001920 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001921 }
1922 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1923 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001924 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001925 }
1926 return result;
1927}
1928
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001929// Test if two VkExtent3D structs are equivalent
1930static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1931 bool result = true;
1932 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1933 (extent->depth != other_extent->depth)) {
1934 result = false;
1935 }
1936 return result;
1937}
1938
Dave Houltonee281a52017-12-08 13:51:02 -07001939// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1940// Destination image texel extents must be adjusted by block size for the dest validation checks
1941VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1942 VkExtent3D adjusted_extent = extent;
1943 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001944 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001945 adjusted_extent.width /= block_size.width;
1946 adjusted_extent.height /= block_size.height;
1947 adjusted_extent.depth /= block_size.depth;
1948 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001949 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001950 adjusted_extent.width *= block_size.width;
1951 adjusted_extent.height *= block_size.height;
1952 adjusted_extent.depth *= block_size.depth;
1953 }
1954 return adjusted_extent;
1955}
1956
Dave Houlton6f9059e2017-05-02 17:15:13 -06001957// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001958static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1959 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001960
1961 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001962 if (mip >= img->createInfo.mipLevels) {
1963 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001964 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001965
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001966 // 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 -06001967 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001968
Dave Houltone48cd112019-01-03 17:01:18 -07001969 // If multi-plane, adjust per-plane extent
1970 if (FormatIsMultiplane(img->createInfo.format)) {
1971 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1972 extent.width /= divisors.width;
1973 extent.height /= divisors.height;
1974 }
1975
Jeff Bolzef40fec2018-09-01 22:04:34 -05001976 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1977 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001978 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001979 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1980 } else {
1981 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1982 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1983 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1984 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001985
Dave Houlton6f9059e2017-05-02 17:15:13 -06001986 // Image arrays have an effective z extent that isn't diminished by mip level
1987 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001988 extent.depth = img->createInfo.arrayLayers;
1989 }
1990
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001991 return extent;
1992}
1993
1994// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001995static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001996 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1997}
1998
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001999// Test if the extent argument has any dimensions set to 0.
2000static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2001 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2002}
2003
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002004// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002005VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2007 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06002008 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002009 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002010 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002011 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002012 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002013 granularity.width *= block_size.width;
2014 granularity.height *= block_size.height;
2015 }
2016 }
2017 return granularity;
2018}
2019
2020// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2021static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2022 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002023 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2024 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002025 valid = false;
2026 }
2027 return valid;
2028}
2029
2030// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002031bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002032 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002033 bool skip = false;
2034 VkExtent3D offset_extent = {};
2035 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2036 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2037 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002038 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002039 // 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 -07002040 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002041 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 -04002042 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002043 "%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 "
2044 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002045 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002046 }
2047 } else {
2048 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2049 // integer multiples of the image transfer granularity.
2050 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002051 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 -04002052 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002053 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2054 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002055 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2056 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002057 }
2058 }
2059 return skip;
2060}
2061
2062// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002063bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002064 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002065 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002066 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002067 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002068 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2069 // subresource extent.
2070 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002071 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 -04002072 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002073 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2074 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2075 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2076 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002077 }
2078 } else {
2079 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2080 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2081 // subresource extent dimensions.
2082 VkExtent3D offset_extent_sum = {};
2083 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2084 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2085 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002086 bool x_ok = true;
2087 bool y_ok = true;
2088 bool z_ok = true;
2089 switch (image_type) {
2090 case VK_IMAGE_TYPE_3D:
2091 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2092 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002093 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002094 case VK_IMAGE_TYPE_2D:
2095 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2096 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002097 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002098 case VK_IMAGE_TYPE_1D:
2099 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2100 (subresource_extent->width == offset_extent_sum.width));
2101 break;
2102 default:
2103 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2104 assert(false);
2105 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002106 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002107 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 -04002108 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002109 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2110 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2111 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2112 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2113 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2114 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002115 }
2116 }
2117 return skip;
2118}
2119
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002120bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002121 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002122 bool skip = false;
2123 if (mip_level >= img->createInfo.mipLevels) {
2124 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2125 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002126 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2127 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002128 }
2129 return skip;
2130}
2131
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002132bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002133 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002134 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002135 bool skip = false;
2136 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2137 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2138 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2139 HandleToUint64(cb_node->commandBuffer), vuid,
2140 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002141 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002142 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2143 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002144 }
2145 return skip;
2146}
2147
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002148// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002149bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002150 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002151 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002152 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002153 VkExtent3D granularity = GetScaledItg(cb_node, img);
2154 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002155 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002156 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002157 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002158 return skip;
2159}
2160
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002161// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002162bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002163 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002164 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002165 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002166 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002167 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2168 skip |=
2169 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002171 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002172 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2173 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002174
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002175 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002176 granularity = GetScaledItg(cb_node, dst_img);
2177 skip |=
2178 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002179 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002180 const VkExtent3D dest_effective_extent =
2181 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002182 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002183 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002184 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002185 return skip;
2186}
2187
Dave Houlton6f9059e2017-05-02 17:15:13 -06002188// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002189bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002190 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002191 bool skip = false;
2192
2193 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002194 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002195
2196 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002197 const VkExtent3D src_copy_extent = region.extent;
2198 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002199 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2200
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 bool slice_override = false;
2202 uint32_t depth_slices = 0;
2203
2204 // Special case for copying between a 1D/2D array and a 3D image
2205 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2206 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002207 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002208 slice_override = (depth_slices != 1);
2209 } 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 -07002210 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002211 slice_override = (depth_slices != 1);
2212 }
2213
2214 // Do all checks on source image
2215 //
2216 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002217 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2218 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 -06002219 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002220 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002221 "be 0 and 1, respectively.",
2222 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002223 }
2224 }
2225
Dave Houlton533be9f2018-03-26 17:08:30 -06002226 // VUID-VkImageCopy-srcImage-01785
2227 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2228 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 -06002229 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002230 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002231 "these must be 0 and 1, respectively.",
2232 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233 }
2234
Dave Houlton533be9f2018-03-26 17:08:30 -06002235 // VUID-VkImageCopy-srcImage-01787
2236 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2237 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 -06002238 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002239 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2240 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002241 }
2242
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002243 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002244 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002245 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 skip |=
2247 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002248 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002249 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002250 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2251 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 }
2253 }
2254 } else { // Pre maint 1
2255 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002256 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002257 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 -06002258 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002259 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2260 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002261 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2262 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002263 }
2264 }
2265 }
2266
Dave Houltonc991cc92018-03-06 11:08:51 -07002267 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002268 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002269 if (FormatIsCompressed(src_state->createInfo.format) ||
2270 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002271 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002272 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002273 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2274 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2275 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002276 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002277 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 -07002278 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002280 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002281 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 }
2283
Dave Houlton94a00372017-12-14 15:08:47 -07002284 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002285 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2286 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002287 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 skip |=
2289 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002290 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002291 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002292 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002293 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 }
2295
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002296 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002297 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2298 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002299 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002300 skip |=
2301 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002302 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002304 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002305 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002306 }
2307
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002308 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002309 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2310 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002311 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312 skip |=
2313 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002314 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002315 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002316 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002317 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 }
2319 } // Compressed
2320
2321 // Do all checks on dest image
2322 //
2323 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002324 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002325 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002326 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002327 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002328 "these must be 0 and 1, respectively.",
2329 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002330 }
2331 }
2332
Dave Houlton533be9f2018-03-26 17:08:30 -06002333 // VUID-VkImageCopy-dstImage-01786
2334 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2335 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 -06002336 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002337 "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 -06002338 "and 1, respectively.",
2339 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002340 }
2341
2342 // VUID-VkImageCopy-dstImage-01788
2343 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2344 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 -06002345 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002346 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2347 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002348 }
2349
2350 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002351 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002352 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 -06002353 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002354 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002355 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2356 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002357 }
2358 }
2359 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002360 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002361 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002362 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002363 skip |=
2364 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002365 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002366 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002367 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2368 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002369 }
2370 }
2371 } else { // Pre maint 1
2372 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002373 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002374 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 -06002375 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002376 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2377 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002378 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2379 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002380 }
2381 }
2382 }
2383
Dave Houltonc991cc92018-03-06 11:08:51 -07002384 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2385 if (FormatIsCompressed(dst_state->createInfo.format) ||
2386 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002387 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002388
2389 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002390 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2391 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2392 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002393 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002395 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002396 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002397 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002398 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002399 }
2400
Dave Houlton94a00372017-12-14 15:08:47 -07002401 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002402 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2403 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002404 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002405 skip |=
2406 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002407 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002408 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002409 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002410 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002411 }
2412
Dave Houltonee281a52017-12-08 13:51:02 -07002413 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2414 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2415 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002416 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002417 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 -07002418 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002419 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2420 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002421 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002422 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002423 }
2424
Dave Houltonee281a52017-12-08 13:51:02 -07002425 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2426 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2427 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002428 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002429 skip |=
2430 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002431 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002432 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002433 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002434 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002435 }
2436 } // Compressed
2437 }
2438 return skip;
2439}
2440
Dave Houltonc991cc92018-03-06 11:08:51 -07002441// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002442bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002443 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002444 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002445
2446 // Neither image is multiplane
2447 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2448 // If neither image is multi-plane the aspectMask member of src and dst must match
2449 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2450 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002451 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002452 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2453 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 -06002454 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002455 }
2456 } else {
2457 // Source image multiplane checks
2458 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2459 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2460 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2461 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002462 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002463 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 -06002464 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002465 }
2466 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2467 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2468 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002469 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002470 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 -06002471 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002472 }
2473 // Single-plane to multi-plane
2474 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2475 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2476 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002477 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002478 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 -06002479 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002480 }
2481
2482 // Dest image multiplane checks
2483 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2484 aspect = region.dstSubresource.aspectMask;
2485 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2486 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002487 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002488 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 -06002489 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002490 }
2491 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2492 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2493 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002494 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002496 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002497 }
2498 // Multi-plane to single-plane
2499 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2500 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2501 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002502 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002503 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 -06002504 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002505 }
2506 }
2507
2508 return skip;
2509}
2510
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002511bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2512 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2513 const VkImageCopy *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002514 const auto *cb_node = GetCBState(commandBuffer);
2515 const auto *src_image_state = GetImageState(srcImage);
2516 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002517 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002518
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002519 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002520
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002521 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2522
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002523 for (uint32_t i = 0; i < regionCount; i++) {
2524 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002525
2526 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2527 VkExtent3D src_copy_extent = region.extent;
2528 VkExtent3D dst_copy_extent =
2529 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2530
Dave Houlton6f9059e2017-05-02 17:15:13 -06002531 bool slice_override = false;
2532 uint32_t depth_slices = 0;
2533
2534 // Special case for copying between a 1D/2D array and a 3D image
2535 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2536 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2537 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002538 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002539 slice_override = (depth_slices != 1);
2540 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2541 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002542 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002543 slice_override = (depth_slices != 1);
2544 }
2545
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002546 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2547 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2548 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002549 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002550 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002551 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002552 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002553 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2554 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002555 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002556 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2557 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002558
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002559 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002560 // No chance of mismatch if we're overriding depth slice count
2561 if (!slice_override) {
2562 // The number of depth slices in srcSubresource and dstSubresource must match
2563 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2564 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002565 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2566 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002567 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002568 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2569 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002570 if (src_slices != dst_slices) {
2571 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002572 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002573 << "] do not match";
2574 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 -06002575 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002576 }
2577 }
2578 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002579 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002580 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002581 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002582 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002583 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002584 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 -06002585 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002586 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002587 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002588
Dave Houltonc991cc92018-03-06 11:08:51 -07002589 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002590 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002591 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002592 }
2593
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002594 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002595 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2596 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002597 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002598 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 -06002599 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002600 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002601 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002602
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002603 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002604 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002605 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002606 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002607 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2608 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 -06002609 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002610 }
2611
2612 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002613 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002614 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002615 ss << "vkCmdCopyImage(): pRegion[" << i
2616 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002617 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 -06002618 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002619 }
2620
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002621 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2622 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2623 // 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 -07002624 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2625 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002626 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002627 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002628 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2629 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2630 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002631 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002632 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002633 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002634
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002635 // 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 -07002636 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2637 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002638 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002639 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002640 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2641 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2642 << " ] exceeds the destination image dimensions";
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-vkCmdCopyImage-pRegions-00123", "%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 Houltonfc1a4052017-04-27 14:32:45 -06002648 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002649 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2650 if (slice_override) src_copy_extent.depth = depth_slices;
2651 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002652 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002653 skip |=
2654 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2655 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2656 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2657 "width [%1d].",
2658 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002659 }
2660
2661 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002662 skip |=
2663 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2664 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2665 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2666 "height [%1d].",
2667 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002668 }
2669 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002670 skip |=
2671 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2672 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2673 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2674 "depth [%1d].",
2675 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002676 }
2677
Dave Houltonee281a52017-12-08 13:51:02 -07002678 // Adjust dest extent if necessary
2679 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2680 if (slice_override) dst_copy_extent.depth = depth_slices;
2681
2682 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002683 if (extent_check & x_bit) {
2684 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002685 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002686 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002687 "width [%1d].",
2688 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002689 }
2690 if (extent_check & y_bit) {
2691 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 -06002692 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002693 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002694 "height [%1d].",
2695 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002696 }
2697 if (extent_check & z_bit) {
2698 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002699 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002700 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002701 "depth [%1d].",
2702 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002703 }
2704
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002705 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2706 // must not overlap in memory
2707 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002708 for (uint32_t j = 0; j < regionCount; j++) {
2709 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002710 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002711 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002712 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002713 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 -06002714 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002715 }
2716 }
2717 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002718 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002719
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002720 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2721 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2722 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002723 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002724 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2725 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002726 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 -06002727 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002728 }
2729 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002730 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002731 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2732 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 -06002733 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002734 }
2735 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002736
Dave Houlton33c22b72017-02-28 13:16:02 -07002737 // Source and dest image sample counts must match
2738 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2739 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2740 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002741 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002742 }
2743
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002744 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2745 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002746 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002747 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2748 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2749 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2750 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002751 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002752 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2753 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2754 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2755 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002756 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002757 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002758 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002759 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2760 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002761 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002762 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2763 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2764 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2765 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2766 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2767 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002768 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002769 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002770 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2771 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002772 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002773 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2774 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002775 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2776 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002777 }
2778
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002779 return skip;
2780}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002781
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002782void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2783 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2784 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002785 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2786 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002787 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002788 auto src_image_state = GetImageState(srcImage);
2789 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002790
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002791 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002792 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002793 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2794 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002795 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002796}
2797
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002798// Returns true if sub_rect is entirely contained within rect
2799static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2800 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2801 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2802 return false;
2803 return true;
2804}
2805
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002806bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002807 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2808 const VkRect2D &render_area, uint32_t rect_count,
2809 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002810 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002811 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2812 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002813 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002814 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002815
2816 for (uint32_t j = 0; j < rect_count; j++) {
2817 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002818 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 -07002819 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2820 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2821 "the current render pass instance.",
2822 j);
2823 }
2824
2825 if (image_view_state) {
2826 // The layers specified by a given element of pRects must be contained within every attachment that
2827 // pAttachments refers to
2828 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2829 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2830 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2832 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2833 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2834 "of pAttachment[%d].",
2835 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002836 }
2837 }
2838 }
2839 return skip;
2840}
2841
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002842bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2843 const VkClearAttachment *pAttachments, uint32_t rectCount,
2844 const VkClearRect *pRects) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002845 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002846 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002847 if (!cb_node) return skip;
2848
2849 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2850 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2851 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
2852 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
2853 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
2854 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2855 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
2856 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2857 // CmdClearAttachments.
2858 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Lockee9aeebf2019-03-03 23:50:08 -07002859 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
locke-lunarg9edc2812019-06-17 23:18:52 -06002860 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
Lockee9aeebf2019-03-03 23:50:08 -07002861 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2862 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002863 }
Petr Kraus2dffb382019-08-10 02:52:12 +02002864 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002865
2866 // Validate that attachment is in reference list of active subpass
2867 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002868 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002869 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002870 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002871 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002872 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002873
John Zulauf3a548ef2019-02-01 16:14:07 -07002874 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2875 auto clear_desc = &pAttachments[attachment_index];
2876 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002877
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002878 if (0 == clear_desc->aspectMask) {
2879 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 -06002880 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002881 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2882 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 -06002883 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002884 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002885 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2886 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2887 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2888 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002889 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2890 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2891 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2892 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2893 attachment_index, clear_desc->colorAttachment,
2894 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2895 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2896 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002897
John Zulauff2582972019-02-09 14:53:30 -07002898 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2899 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002900 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002901 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2902 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002903 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002904 " subpass %u. colorAttachmentCount=%u",
2905 attachment_index, clear_desc->colorAttachment,
2906 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2907 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002908 }
John Zulauff2582972019-02-09 14:53:30 -07002909 fb_attachment = color_attachment;
2910
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002911 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2912 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2913 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002914 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002915 skip |=
2916 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2917 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002918 }
2919 } else { // Must be depth and/or stencil
2920 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2921 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002922 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002923 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 -07002924 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2925 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002926 }
2927 if (!subpass_desc->pDepthStencilAttachment ||
2928 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2929 skip |= log_msg(
2930 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002931 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002932 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002933 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002934 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002935 }
2936 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002937 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002938 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2939 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002940 }
2941 }
2942 }
2943 return skip;
2944}
2945
2946void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2947 const VkClearAttachment *pAttachments, uint32_t rectCount,
2948 const VkClearRect *pRects) {
2949 auto *cb_node = GetCBState(commandBuffer);
2950 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
2951 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
2952 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
2953 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
2954 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2955 const auto clear_desc = &pAttachments[attachment_index];
2956 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2957 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
2958 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
2959 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2960 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
2961 subpass_desc->pDepthStencilAttachment) {
2962 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
2963 }
2964 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002965 if (!clear_rect_copy) {
2966 // We need a copy of the clear rectangles that will persist until the last lambda executes
2967 // but we want to create it as lazily as possible
2968 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002969 }
John Zulauf441558b2019-08-12 11:47:39 -06002970 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2971 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002972 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06002973 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002974 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06002975 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002976 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2977 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002978 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2979 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002980 return skip;
2981 };
2982 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002983 }
2984 }
2985 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002986}
2987
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002988bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2989 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2990 const VkImageResolve *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002991 const auto *cb_node = GetCBState(commandBuffer);
2992 const auto *src_image_state = GetImageState(srcImage);
2993 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002994
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002995 bool skip = false;
2996 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002997 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2998 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002999 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003000 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003001 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3002 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003003 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3004 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003005
Cort Stratton7df30962018-05-17 19:45:57 -07003006 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003007 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003008 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003009 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3010 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3011 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003012 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003013 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3014 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003015 // For each region, the number of layers in the image subresource should not be zero
3016 // For each region, src and dest image aspect must be color only
3017 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003018 skip |=
3019 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3020 skip |=
3021 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003022 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003023 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3024 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003025 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003026 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3027 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003028 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3029 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3030 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3031 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3032 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003033 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3034 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003035 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003036 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3037 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003038
3039 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003040 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3041 skip |= log_msg(
3042 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003043 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003044 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003045 }
Cort Stratton7df30962018-05-17 19:45:57 -07003046 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003047 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3048 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3049 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003050 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003051 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 -06003052 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003053 }
3054 }
3055
3056 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3057 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003058 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 -06003059 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003060 }
3061 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3062 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003063 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 -06003064 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003065 }
3066 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3067 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3068 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 -06003069 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003070 }
3071 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3072 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3073 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 -06003074 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003075 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003076 } else {
3077 assert(0);
3078 }
3079 return skip;
3080}
3081
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003082bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3083 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3084 const VkImageBlit *pRegions, VkFilter filter) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003085 const auto *cb_node = GetCBState(commandBuffer);
3086 const auto *src_image_state = GetImageState(srcImage);
3087 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003088
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003089 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003090 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003091 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003092 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003093 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003094 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003095 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003096 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003097 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003098 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3099 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003100 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003101 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3102 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003103 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003104 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3105 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003106 skip |=
3107 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003108 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3109 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003110 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003111 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003112 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003113 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003114
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003115 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003116
Dave Houlton33c2d252017-06-09 17:08:32 -06003117 VkFormat src_format = src_image_state->createInfo.format;
3118 VkFormat dst_format = dst_image_state->createInfo.format;
3119 VkImageType src_type = src_image_state->createInfo.imageType;
3120 VkImageType dst_type = dst_image_state->createInfo.imageType;
3121
Cort Stratton186b1a22018-05-01 20:18:06 -04003122 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003123 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003124 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3125 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003126 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003127 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3128 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3129 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003130 }
3131
3132 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3133 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 -06003134 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003135 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003136 }
3137
Dave Houlton33c2d252017-06-09 17:08:32 -06003138 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3139 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3140 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 -06003141 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003142 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 }
3144
3145 // Validate consistency for unsigned formats
3146 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3147 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003148 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003149 << "the other one must also have unsigned integer format. "
3150 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3151 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 -06003152 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003153 }
3154
3155 // Validate consistency for signed formats
3156 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3157 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003158 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003159 << "the other one must also have signed integer format. "
3160 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3161 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 -06003162 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003163 }
3164
3165 // Validate filter for Depth/Stencil formats
3166 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3167 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003168 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003169 << "then filter must be VK_FILTER_NEAREST.";
3170 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003171 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003172 }
3173
3174 // Validate aspect bits and formats for depth/stencil images
3175 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3176 if (src_format != dst_format) {
3177 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003178 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003179 << "stencil, the other one must have exactly the same format. "
3180 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3181 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003182 skip |=
3183 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3184 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003185 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003186 } // Depth or Stencil
3187
3188 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003189 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003190 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003191 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3192 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3193 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003194 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003195 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3196 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003197 for (uint32_t i = 0; i < regionCount; i++) {
3198 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003199 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003200 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003201 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3202 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003203 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003204 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3205 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003206 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3207 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3208 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003209 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003210 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003211 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003212 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003213 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3214 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003215 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003216 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3217 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003218 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003219 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3220 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003221 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003222 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003223 skip |=
3224 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3225 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003226 }
Dave Houlton48989f32017-05-26 15:01:46 -06003227 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3228 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003229 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003230 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003231 skip |=
3232 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3233 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003234 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003235
3236 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003237 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003238 skip |= log_msg(
3239 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3240 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3241 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003242 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003243
Dave Houlton48989f32017-05-26 15:01:46 -06003244 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003245 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 -06003246 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003247 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003248 }
Dave Houlton48989f32017-05-26 15:01:46 -06003249
Dave Houlton33c2d252017-06-09 17:08:32 -06003250 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3251 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 -06003252 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003253 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003254 "image format %s.",
3255 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003256 }
3257
3258 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3259 skip |= log_msg(
3260 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003261 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003262 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3263 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 }
3265
Dave Houlton48989f32017-05-26 15:01:46 -06003266 // Validate source image offsets
3267 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003268 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003269 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003270 skip |=
3271 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3272 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3273 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3274 "of (%1d, %1d). These must be (0, 1).",
3275 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003276 }
3277 }
3278
Dave Houlton33c2d252017-06-09 17:08:32 -06003279 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003280 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3281 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003282 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003283 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003284 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3285 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003286 }
3287 }
3288
Dave Houlton33c2d252017-06-09 17:08:32 -06003289 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003290 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3291 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003292 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003293 skip |= log_msg(
3294 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3295 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3296 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3297 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003298 }
3299 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3300 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003302 skip |= log_msg(
3303 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003304 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003305 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003306 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003307 }
3308 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3309 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003310 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003311 skip |= log_msg(
3312 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3313 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3314 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3315 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003316 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003317 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003318 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 -06003319 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003320 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003321 }
Dave Houlton48989f32017-05-26 15:01:46 -06003322
3323 // Validate dest image offsets
3324 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003325 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003326 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003327 skip |=
3328 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3329 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3330 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3331 "(%1d, %1d). These must be (0, 1).",
3332 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003333 }
3334 }
3335
Dave Houlton33c2d252017-06-09 17:08:32 -06003336 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003337 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3338 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 -06003339 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003340 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003341 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3342 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003343 }
3344 }
3345
Dave Houlton33c2d252017-06-09 17:08:32 -06003346 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003347 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3348 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003349 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003350 skip |= log_msg(
3351 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3352 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3353 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3354 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003355 }
3356 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3357 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003358 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003359 skip |= log_msg(
3360 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003361 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003362 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003363 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003364 }
3365 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3366 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003367 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003368 skip |= log_msg(
3369 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3370 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3371 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3372 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003373 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003374 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003375 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 -06003376 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003377 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003378 }
3379
Dave Houlton33c2d252017-06-09 17:08:32 -06003380 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3381 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3382 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003383 skip |=
3384 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3385 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3386 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3387 "layerCount other than 1.",
3388 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003389 }
3390 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003391 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003392 } else {
3393 assert(0);
3394 }
3395 return skip;
3396}
3397
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003398void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3399 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3400 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003401 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3402 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003403 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003404 auto src_image_state = GetImageState(srcImage);
3405 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003406
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003407 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003408 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003409 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3410 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003411 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003412}
3413
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003414// 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 -06003415bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3416 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003417 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003418 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003419 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003420 // Iterate over the layout maps for each referenced image
3421 for (const auto &layout_map_entry : pCB->image_layout_map) {
3422 const auto image = layout_map_entry.first;
3423 const auto *image_state = GetImageState(image);
3424 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003425 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003426 ImageSubresourcePair isr_pair;
3427 isr_pair.image = image;
3428 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003429 // Validate the initial_uses for each subresource referenced
3430 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3431 isr_pair.subresource = (*it_init).subresource;
3432 VkImageLayout initial_layout = (*it_init).layout;
3433 VkImageLayout image_layout;
3434 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3435 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3436 // TODO: Set memory invalid which is in mem_tracker currently
3437 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003438 // Need to look up the inital layout *state* to get a bit more information
3439 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3440 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3441 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3442 if (!matches) {
3443 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003444 skip |= log_msg(
3445 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3446 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003447 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003448 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003449 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003450 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3451 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003452 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003453 }
3454 }
John Zulauff660ad62019-03-23 07:16:05 -06003455 }
3456
3457 // Update all layout set operations (which will be a subset of the initial_layouts
3458 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3459 VkImageLayout layout = (*it_set).layout;
3460 isr_pair.subresource = (*it_set).subresource;
3461 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003462 }
3463 }
John Zulauff660ad62019-03-23 07:16:05 -06003464
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003465 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003466}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003467
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003468void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003469 for (const auto &layout_map_entry : pCB->image_layout_map) {
3470 const auto image = layout_map_entry.first;
3471 const auto *image_state = GetImageState(image);
3472 if (!image_state) continue; // Can't set layouts of a dead image
3473 const auto &subres_map = layout_map_entry.second;
3474 ImageSubresourcePair isr_pair;
3475 isr_pair.image = image;
3476 isr_pair.hasSubresource = true;
3477
3478 // Update all layout set operations (which will be a subset of the initial_layouts
3479 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3480 VkImageLayout layout = (*it_set).layout;
3481 isr_pair.subresource = (*it_set).subresource;
3482 SetGlobalLayout(isr_pair, layout);
3483 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003484 }
3485}
3486
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003487// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003488// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3489// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003490bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3491 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003492 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003493 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003494 const char *vuid;
3495 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3496
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003497 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3498 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003499 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3500 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3501 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003502 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003503 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3504 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3505 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3506 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3507 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3508 skip |=
3509 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3510 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003511 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003512 }
3513 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003514 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3515 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003516 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003517 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003518 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 -06003519 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003520 }
3521 }
3522
3523 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3524 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003525 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003526 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003527 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 -06003528 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003529 }
3530 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003531 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003532}
3533
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003534bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
John Zulauf9d2b6382019-07-25 15:21:36 -06003535 const VkRenderPassCreateInfo2KHR *pCreateInfo) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003536 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003537 const char *vuid;
3538 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3539 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003540
Jason Ekstranda1906302017-12-03 20:16:32 -08003541 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3542 VkFormat format = pCreateInfo->pAttachments[i].format;
3543 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3544 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3545 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003546 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 -06003547 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003548 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3549 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3550 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3551 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003552 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003553 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003554 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 -06003555 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003556 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3557 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3558 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3559 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003560 }
3561 }
3562 }
3563
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003564 // Track when we're observing the first use of an attachment
3565 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3566 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003567 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003568
3569 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3570 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3571 auto attach_index = subpass.pInputAttachments[j].attachment;
3572 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003573 switch (subpass.pInputAttachments[j].layout) {
3574 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3575 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3576 // These are ideal.
3577 break;
3578
3579 case VK_IMAGE_LAYOUT_GENERAL:
3580 // May not be optimal. TODO: reconsider this warning based on other constraints.
3581 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003582 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003583 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3584 break;
3585
Tobias Hectorbbb12282018-10-22 15:17:59 +01003586 case VK_IMAGE_LAYOUT_UNDEFINED:
3587 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3588 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3589 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3590 "Layout for input attachment reference %u in subpass %u is %s but must be "
3591 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003592 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003593 break;
3594
Graeme Leese668a9862018-10-08 10:40:02 +01003595 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3596 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003597 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003598 break;
3599 } else {
3600 // Intentionally fall through to generic error message
3601 }
3602 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003603
Cort Stratton7547f772017-05-04 15:18:52 -07003604 default:
3605 // No other layouts are acceptable
3606 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 -06003607 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003608 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3609 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3610 }
3611
Cort Stratton7547f772017-05-04 15:18:52 -07003612 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003613 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3614 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003615
3616 bool used_as_depth =
3617 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3618 bool used_as_color = false;
3619 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3620 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3621 }
3622 if (!used_as_depth && !used_as_color &&
3623 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003624 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3625 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3626 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3627 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003628 }
3629 }
3630 attach_first_use[attach_index] = false;
3631 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003632
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003633 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3634 auto attach_index = subpass.pColorAttachments[j].attachment;
3635 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3636
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003637 // TODO: Need a way to validate shared presentable images here, currently just allowing
3638 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3639 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003640 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003641 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003642 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003643 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3644 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003645 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003646
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003647 case VK_IMAGE_LAYOUT_GENERAL:
3648 // May not be optimal; TODO: reconsider this warning based on other constraints?
3649 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003650 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003651 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3652 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003653
Tobias Hectorbbb12282018-10-22 15:17:59 +01003654 case VK_IMAGE_LAYOUT_UNDEFINED:
3655 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3656 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3657 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3658 "Layout for color attachment reference %u in subpass %u is %s but should be "
3659 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3660 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3661 break;
3662
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003663 default:
3664 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 -06003665 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003666 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3667 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003668 }
3669
John Zulauf4eee2692019-02-09 16:14:25 -07003670 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3671 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3672 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003673 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3674 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 -07003675 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003676 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003677 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003678 }
3679
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003680 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003681 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3682 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003683 }
3684 attach_first_use[attach_index] = false;
3685 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003686
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003687 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3688 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003689 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3690 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3691 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003692 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003693
Dave Houltona9df0ce2018-02-07 10:51:23 -07003694 case VK_IMAGE_LAYOUT_GENERAL:
3695 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3696 // doing a bunch of transitions.
3697 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003698 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003699 "GENERAL layout for depth attachment may not give optimal performance.");
3700 break;
3701
Tobias Hectorbbb12282018-10-22 15:17:59 +01003702 case VK_IMAGE_LAYOUT_UNDEFINED:
3703 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3704 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3705 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3706 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3707 "layout or GENERAL.",
3708 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3709 break;
3710
Dave Houltona9df0ce2018-02-07 10:51:23 -07003711 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3712 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003713 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003714 break;
3715 } else {
3716 // Intentionally fall through to generic error message
3717 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003718 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003719
Dave Houltona9df0ce2018-02-07 10:51:23 -07003720 default:
3721 // No other layouts are acceptable
3722 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 -06003723 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003724 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3725 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3726 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003727 }
3728
3729 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3730 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003731 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3732 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003733 }
3734 attach_first_use[attach_index] = false;
3735 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003736 }
3737 return skip;
3738}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003739
Mark Lobodzinski96210742017-02-09 10:33:46 -07003740// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3741// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06003742bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003743 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003744 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003745 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003746 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003747 if (strict) {
3748 correct_usage = ((actual & desired) == desired);
3749 } else {
3750 correct_usage = ((actual & desired) != 0);
3751 }
3752 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003753 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003754 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06003755 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
3756 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06003757 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3758 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003759 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06003760 skip =
3761 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 -06003762 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3763 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003764 }
3765 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003766 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003767}
3768
3769// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3770// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003771bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003772 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003773 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
3774 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003775}
3776
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003777bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003778 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003779 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003780 bool skip = false;
3781 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3782 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003783 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3784 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003785 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07003786 format_properties.linearTilingFeatures, image_state->createInfo.format,
3787 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003788 }
3789 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3790 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3791 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3792 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003793 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003794 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003795 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003796 }
3797 }
3798 return skip;
3799}
3800
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003801bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003802 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003803 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003804 // layerCount must not be zero
3805 if (subresource_layers->layerCount == 0) {
3806 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3807 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3808 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3809 }
3810 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3811 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3812 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3813 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3814 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3815 }
3816 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3817 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3818 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3820 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3821 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3822 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3823 func_name, i, member);
3824 }
3825 return skip;
3826}
3827
Mark Lobodzinski96210742017-02-09 10:33:46 -07003828// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3829// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003830bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06003831 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003832 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
3833 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003834}
3835
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003836bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3837 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003838 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003839
3840 const VkDeviceSize &range = pCreateInfo->range;
3841 if (range != VK_WHOLE_SIZE) {
3842 // Range must be greater than 0
3843 if (range <= 0) {
3844 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3845 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3846 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3847 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3848 range);
3849 }
3850 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02003851 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
3852 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003853 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3854 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3855 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3856 ") 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 +02003857 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003858 range, format_size);
3859 }
3860 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02003861 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
3862 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3863 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3864 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3865 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
3866 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3867 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003868 }
3869 // The sum of range and offset must be less than or equal to the size of buffer
3870 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3871 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3872 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3873 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3874 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3875 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3876 range, pCreateInfo->offset, buffer_state->createInfo.size);
3877 }
3878 }
3879 return skip;
3880}
3881
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003882bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003883 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003884 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003885 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3886 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3887 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3888 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3889 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3890 "be supported for uniform texel buffers");
3891 }
3892 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3893 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3894 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3895 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3896 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3897 "be supported for storage texel buffers");
3898 }
3899 return skip;
3900}
3901
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003902bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3903 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003904 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003905
Dave Houltond8ed0212018-05-16 17:18:24 -06003906 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003907
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003908 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003909 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 -06003910 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003911 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003912 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003913 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003914
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003915 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003916 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 -06003917 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003918 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003919 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003920 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003921
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003922 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003923 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 -06003924 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003925 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003926 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003927 }
Jeff Bolz87697532019-01-11 22:54:00 -06003928
3929 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3930 if (chained_devaddr_struct) {
3931 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3932 chained_devaddr_struct->deviceAddress != 0) {
3933 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3934 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3935 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3936 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3937 }
3938 }
3939
3940 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003941 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003942 skip |= log_msg(
3943 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3944 "VUID-VkBufferCreateInfo-flags-02605",
3945 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3946 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3947 }
3948
3949 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003950 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003951 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3952 "VUID-VkBufferCreateInfo-usage-02606",
3953 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3954 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3955 }
3956
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003957 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003958 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3959 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3960 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003961 }
3962
Mark Lobodzinski96210742017-02-09 10:33:46 -07003963 return skip;
3964}
3965
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003966bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3967 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003968 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003969 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003970 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3971 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003972 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003973 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3974 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003975 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003976 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3977 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3978 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003979
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003980 // Buffer view offset must be less than the size of buffer
3981 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3982 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3983 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3984 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3985 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3986 pCreateInfo->offset, buffer_state->createInfo.size);
3987 }
3988
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003989 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05003990 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3991 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
3992 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
3993 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3994 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
3995 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3996 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3997 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3998 }
3999
4000 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4001 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4002 if ((elementSize % 3) == 0) {
4003 elementSize /= 3;
4004 }
4005 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4006 VkDeviceSize alignmentRequirement =
4007 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4008 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4009 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4010 }
4011 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4012 skip |= log_msg(
4013 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4014 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4015 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4016 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4017 ") must be a multiple of the lesser of "
4018 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4019 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4020 "(%" PRId32
4021 ") is VK_TRUE, the size of a texel of the requested format. "
4022 "If the size of a texel is a multiple of three bytes, then the size of a "
4023 "single component of format is used instead",
4024 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4025 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4026 }
4027 }
4028 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4029 VkDeviceSize alignmentRequirement =
4030 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4031 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4032 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4033 }
4034 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4035 skip |= log_msg(
4036 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4037 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4038 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4039 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4040 ") must be a multiple of the lesser of "
4041 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4042 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4043 "(%" PRId32
4044 ") is VK_TRUE, the size of a texel of the requested format. "
4045 "If the size of a texel is a multiple of three bytes, then the size of a "
4046 "single component of format is used instead",
4047 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4048 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4049 }
4050 }
4051 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004052
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004053 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004054
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004055 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004056 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004057 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004058}
4059
Mark Lobodzinski602de982017-02-09 11:01:33 -07004060// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004061bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004062 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004063 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004064 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4065 if (image != VK_NULL_HANDLE) {
4066 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4067 }
4068
Dave Houlton1d2022c2017-03-29 11:43:58 -06004069 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004070 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004071 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004072 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004073 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004074 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004075 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004076 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004077 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004078 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004079 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004080 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004081 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4082 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004083 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004084 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004085 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004086 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4087 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004088 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004089 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004090 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004091 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004092 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004093 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004095 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004096 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004097 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004098 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004099 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004100 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004101 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004102 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004103 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004104 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004105 } else if (FormatIsMultiplane(format)) {
4106 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4107 if (3 == FormatPlaneCount(format)) {
4108 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4109 }
4110 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004111 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004112 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4113 "set, where n = [0, 1, 2].",
4114 func_name);
4115 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004116 }
4117 return skip;
4118}
4119
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004120bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4121 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4122 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004123 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004124 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004125
4126 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004127 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004128 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 -06004129 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004130 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004131 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4132 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004133 }
Petr Kraus4d718682017-05-18 03:38:41 +02004134
Petr Krausffa94af2017-08-08 21:46:02 +02004135 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4136 if (subresourceRange.levelCount == 0) {
4137 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 -06004138 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004139 } else {
4140 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004141
Petr Krausffa94af2017-08-08 21:46:02 +02004142 if (necessary_mip_count > image_mip_count) {
4143 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 -06004144 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004145 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004146 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004147 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004148 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004149 }
Petr Kraus4d718682017-05-18 03:38:41 +02004150 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004151 }
Petr Kraus4d718682017-05-18 03:38:41 +02004152
4153 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004154 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004155 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 -06004156 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004157 "%s: %s.baseArrayLayer (= %" PRIu32
4158 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4159 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004160 }
Petr Kraus4d718682017-05-18 03:38:41 +02004161
Petr Krausffa94af2017-08-08 21:46:02 +02004162 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4163 if (subresourceRange.layerCount == 0) {
4164 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 -06004165 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004166 } else {
4167 const uint64_t necessary_layer_count =
4168 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004169
Petr Krausffa94af2017-08-08 21:46:02 +02004170 if (necessary_layer_count > image_layer_count) {
4171 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 -06004172 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004173 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004174 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004175 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004176 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004177 }
Petr Kraus4d718682017-05-18 03:38:41 +02004178 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004179 }
Petr Kraus4d718682017-05-18 03:38:41 +02004180
Mark Lobodzinski602de982017-02-09 11:01:33 -07004181 return skip;
4182}
4183
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004184bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004185 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004186 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004187 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4188 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4189 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4190
4191 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4192 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4193
4194 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004195 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4196 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004197 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004198 : "VUID-VkImageViewCreateInfo-image-01482")
4199 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4200 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004201 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004202 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4203 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004204
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004205 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004206 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4207 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4208}
4209
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004210bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004211 const VkImageSubresourceRange &subresourceRange,
4212 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004213 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004214 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4215 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4216 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4217 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004218
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004219 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4220 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4221 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004222}
4223
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004224bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004225 const VkImageSubresourceRange &subresourceRange,
4226 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004227 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004228 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4229 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4230 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4231 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004232
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004233 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4234 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004235 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4236}
4237
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004238bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004239 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004240 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004241 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004242 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4243 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4244 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4245 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004246
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004247 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4248 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004249 subresourceRangeErrorCodes);
4250}
4251
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004252bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4253 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004254 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004255 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004256 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004257 skip |=
4258 ValidateImageUsageFlags(image_state,
4259 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4260 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4261 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4262 false, kVUIDUndefined, "vkCreateImageView()",
4263 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4264 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004265 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004266 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004267 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004268 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004269 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004270 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004271
4272 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4273 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004274 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4275 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004276 VkFormat view_format = pCreateInfo->format;
4277 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004278 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004279 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004280
Dave Houltonbd2e2622018-04-10 16:41:14 -06004281 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004282 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004283 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004284 image_usage = chained_ivuci_struct->usage;
4285 }
4286
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004287 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4288 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004289 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004290 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004291 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004292 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004293 std::stringstream ss;
4294 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004295 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004296 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004297 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 -07004298 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004299 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004300 }
4301 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004302 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004303 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4304 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4305 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4306 std::stringstream ss;
4307 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004308 << " is not in the same format compatibility class as "
4309 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004310 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4311 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004312 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 -07004313 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004314 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004315 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004316 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004317 }
4318 } else {
4319 // Format MUST be IDENTICAL to the format the image was created with
4320 if (image_format != view_format) {
4321 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004322 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004323 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004324 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004325 skip |=
4326 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004327 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004328 }
4329 }
4330
4331 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004332 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004333
4334 switch (image_type) {
4335 case VK_IMAGE_TYPE_1D:
4336 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004337 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 -07004338 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004339 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4340 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004341 }
4342 break;
4343 case VK_IMAGE_TYPE_2D:
4344 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4345 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4346 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004347 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 -07004348 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004349 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4350 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004351 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004352 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 -07004353 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004354 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4355 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004356 }
4357 }
4358 break;
4359 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004360 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004361 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4362 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4363 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004364 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004365 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004366 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004367 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4368 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004369 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4370 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004371 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004372 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004373 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004374 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4375 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004376 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4377 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004378 }
4379 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004380 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 -07004381 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004382 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4383 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004384 }
4385 }
4386 } else {
4387 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004388 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 -07004389 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004390 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4391 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004392 }
4393 }
4394 break;
4395 default:
4396 break;
4397 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004398
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004399 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004400 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004401 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004402 }
4403
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004404 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004405 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4406 : format_properties.optimalTilingFeatures;
4407
4408 if (tiling_features == 0) {
4409 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 -07004410 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004411 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4412 "physical device.",
4413 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4414 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4415 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 -07004416 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004417 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4418 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4419 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4420 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4421 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 -07004422 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004423 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4424 "VK_IMAGE_USAGE_STORAGE_BIT.",
4425 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4426 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4427 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4428 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 -07004429 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004430 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4431 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4432 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4433 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4434 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4435 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 -07004436 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004437 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4438 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4439 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004440 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004441
Jeff Bolz9af91c52018-09-01 21:53:57 -05004442 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4443 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4444 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 -07004445 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004446 "vkCreateImageView() If image was created with usage containing "
4447 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4448 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4449 }
4450 if (view_format != VK_FORMAT_R8_UINT) {
4451 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 -07004452 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004453 "vkCreateImageView() If image was created with usage containing "
4454 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4455 }
4456 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004457 }
4458 return skip;
4459}
4460
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004461static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4462 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4463 const VkBufferCopy *pRegions) {
4464 bool skip = false;
4465
4466 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4467 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4468 VkDeviceSize src_min = UINT64_MAX;
4469 VkDeviceSize src_max = 0;
4470 VkDeviceSize dst_min = UINT64_MAX;
4471 VkDeviceSize dst_max = 0;
4472
4473 for (uint32_t i = 0; i < regionCount; i++) {
4474 src_min = std::min(src_min, pRegions[i].srcOffset);
4475 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4476 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4477 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4478
4479 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4480 if (pRegions[i].srcOffset >= src_buffer_size) {
4481 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4482 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4483 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4484 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4485 i, pRegions[i].srcOffset, i, pRegions[i].size);
4486 }
4487
4488 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4489 if (pRegions[i].dstOffset >= dst_buffer_size) {
4490 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4491 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4492 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4493 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4494 i, pRegions[i].dstOffset, i, pRegions[i].size);
4495 }
4496
4497 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4498 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4499 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4500 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4501 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4502 ") is greater than the source buffer size (%" PRIuLEAST64
4503 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4504 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4505 }
4506
4507 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4508 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4509 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4510 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4511 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4512 ") is greater than the destination buffer size (%" PRIuLEAST64
4513 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4514 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4515 }
4516 }
4517
4518 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4519 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4520 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4521 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4522 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4523 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4524 }
4525 }
4526
4527 return skip;
4528}
4529
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004530bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4531 uint32_t regionCount, const VkBufferCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004532 const auto cb_node = GetCBState(commandBuffer);
4533 const auto src_buffer_state = GetBufferState(srcBuffer);
4534 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004535
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004536 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004537 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4538 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004539 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004540 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004541 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4542 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004543 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004544 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4545 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004546 skip |=
4547 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4548 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004549 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4550 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004551 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004552 return skip;
4553}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004554
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004555bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004556 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004557 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004558 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004559 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 -06004560 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004561 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004562 } else {
4563 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004564 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 -06004565 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004566 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004567 }
4568 }
4569 return skip;
4570}
4571
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004572bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004573 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004574 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004575
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004576 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004577 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004578 skip |=
4579 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004580 }
4581 return skip;
4582}
4583
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004584bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004585 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004586
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004587 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004588 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004589 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004590 }
4591 return skip;
4592}
4593
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004594bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4595 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004596 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004597 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004598 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004599 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004600 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004601 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004602 }
4603 return skip;
4604}
4605
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004606bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4607 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004608 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004609 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004610 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004611 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004612 skip |=
4613 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4614 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004615 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004616 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004617 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4618 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004619 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004620 return skip;
4621}
4622
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004623bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4624 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004625 bool skip = false;
4626
4627 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004628 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4629 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004630 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 -06004631 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004632 "%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 -06004633 "and 1, respectively.",
4634 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004635 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004636 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004637
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004638 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4639 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004640 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 -06004641 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004642 "%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 -06004643 "must be 0 and 1, respectively.",
4644 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004645 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004646 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004647
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004648 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4649 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004650 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 -06004651 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004652 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4653 "For 3D images these must be 0 and 1, respectively.",
4654 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004655 }
4656 }
4657
4658 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004659 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004660 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4661
Dave Houltona585d132019-01-18 13:05:42 -07004662 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004663 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 -06004664 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004665 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004666 " must be a multiple of this format's texel size (%" PRIu32 ").",
4667 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004668 }
4669
4670 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004671 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004672 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 -06004673 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004674 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4675 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004676 }
4677
4678 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4679 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004680 skip |=
4681 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004682 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004683 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4684 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004685 }
4686
4687 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4688 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4689 skip |= log_msg(
4690 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004691 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004692 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4693 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004694 }
4695
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004696 // Calculate adjusted image extent, accounting for multiplane image factors
4697 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4698 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4699 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4700 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
4701 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4702 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
4703 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4704 "zero or <= image subresource width (%d).",
4705 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4706 adusted_image_extent.width);
4707 }
4708
4709 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4710 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4711 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
4712 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4713 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
4714 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4715 "zero or <= image subresource height (%d).",
4716 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4717 adusted_image_extent.height);
4718 }
4719
4720 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4721 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4722 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
4723 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4724 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
4725 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4726 "zero or <= image subresource depth (%d).",
4727 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4728 adusted_image_extent.depth);
4729 }
4730
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004731 // subresource aspectMask must have exactly 1 bit set
4732 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4733 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4734 if (aspect_mask_bits.count() != 1) {
4735 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 -06004736 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004737 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004738 }
4739
4740 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004741 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004742 skip |= log_msg(
4743 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004744 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004745 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4746 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004747 }
4748
4749 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004750 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004751 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004752
4753 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004754 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004755 skip |= log_msg(
4756 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004757 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004758 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4759 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004760 }
4761
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004762 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004763 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004764 skip |= log_msg(
4765 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004766 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004767 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4768 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004769 }
4770
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004771 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004772 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4773 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4774 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004775 skip |=
4776 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004777 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004778 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4779 "width & height (%d, %d)..",
4780 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004781 }
4782
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004783 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004784 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004785 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004786 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 -06004787 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004788 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004789 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004790 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004791 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004792
4793 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004794 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004795 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004796 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4797 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 -06004798 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004799 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004800 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004801 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004802 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004803 }
4804
4805 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004806 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004807 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4808 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 -06004809 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004810 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004811 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004812 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004813 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004814 }
4815
4816 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004817 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004818 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4819 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 -06004820 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004821 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004822 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004823 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004824 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004825 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004826 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004827 }
4828
4829 return skip;
4830}
4831
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004832static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004833 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004834 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004835 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004836
4837 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004838 VkExtent3D extent = pRegions[i].imageExtent;
4839 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004840
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004841 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4842 {
Dave Houlton51653902018-06-22 17:32:13 -06004843 skip |=
4844 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4845 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4846 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004847 }
4848
4849 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4850
4851 // If we're using a compressed format, valid extent is rounded up to multiple of block size (per 18.1)
Dave Houlton1d2022c2017-03-29 11:43:58 -06004852 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004853 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004854 if (image_extent.width % block_extent.width) {
4855 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4856 }
4857 if (image_extent.height % block_extent.height) {
4858 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4859 }
4860 if (image_extent.depth % block_extent.depth) {
4861 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4862 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004863 }
4864
Dave Houltonfc1a4052017-04-27 14:32:45 -06004865 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004866 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 -06004867 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004868 }
4869 }
4870
4871 return skip;
4872}
4873
Chris Forbese8ba09a2017-06-01 17:39:02 -07004874static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004875 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004876 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004877 bool skip = false;
4878
4879 VkDeviceSize buffer_size = buff_state->createInfo.size;
4880
4881 for (uint32_t i = 0; i < regionCount; i++) {
4882 VkExtent3D copy_extent = pRegions[i].imageExtent;
4883
4884 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4885 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004886 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4887 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004888
Tom Cooperb2550c72018-10-15 13:08:41 +01004889 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004890 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004891 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004892 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4893 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4894
4895 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4896 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4897 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004898 }
4899
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004900 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4901 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4902 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004903 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004904 } else {
4905 // Calculate buffer offset of final copied byte, + 1.
4906 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4907 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4908 max_buffer_offset *= unit_size; // convert to bytes
4909 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004910
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004911 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004912 skip |=
4913 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4914 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004915 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004916 }
4917 }
4918
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004919 return skip;
4920}
4921
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004922bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4923 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004924 const auto cb_node = GetCBState(commandBuffer);
4925 const auto src_image_state = GetImageState(srcImage);
4926 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004927
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004928 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004929
4930 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004931 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004932
4933 // Command pool must support graphics, compute, or transfer operations
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004934 const auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004935
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004936 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004937
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004938 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4939 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 -06004940 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004941 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004942 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004943 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004944 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004945 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004946 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004947 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004948
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004949 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004950 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004951 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4952 skip |=
4953 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004954
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004955 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004956 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004957 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4958 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004959 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004960 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4961 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004962 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004963 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4964 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004965 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004966 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004967 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004968 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004969 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4970 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4971 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004972 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004973 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004974 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004975 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004976 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4977 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004978 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4979 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4980 skip |=
4981 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4982 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4983 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004984 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4985 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004986 }
4987 return skip;
4988}
4989
John Zulauf1686f232019-07-09 16:27:11 -06004990void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4991 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4992 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
4993
4994 auto cb_node = GetCBState(commandBuffer);
4995 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06004996 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004997 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004998 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004999 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005000}
5001
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005002bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5003 VkImageLayout dstImageLayout, uint32_t regionCount,
5004 const VkBufferImageCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005005 const auto cb_node = GetCBState(commandBuffer);
5006 const auto src_buffer_state = GetBufferState(srcBuffer);
5007 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005008
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005009 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005010
5011 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005012 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005013
5014 // Command pool must support graphics, compute, or transfer operations
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005015 const auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005016 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005017 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5018 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 -06005019 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005020 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005021 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005022 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005023 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005024 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005025 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005026 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005027 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005028 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005029 skip |=
5030 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5031 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005032 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005033 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5034 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005035 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005036 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5037 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005038 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005039 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5040 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005041 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005042 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005043 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005044 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005045 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5046 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5047 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005048 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005049 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005050 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005051 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005052 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5053 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005054 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5055 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5056 skip |=
5057 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5058 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5059 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005060 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5061 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005062 }
5063 return skip;
5064}
5065
John Zulauf1686f232019-07-09 16:27:11 -06005066void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5067 VkImageLayout dstImageLayout, uint32_t regionCount,
5068 const VkBufferImageCopy *pRegions) {
5069 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5070
5071 auto cb_node = GetCBState(commandBuffer);
5072 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005073 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005074 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005075 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005076 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005077}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005078
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005079bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5080 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005081 bool skip = false;
5082 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5083
Dave Houlton1d960ff2018-01-19 12:17:05 -07005084 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005085 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5086 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5087 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005088 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 -06005089 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005090 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005091 }
5092
John Zulaufa26d3c82019-08-14 16:09:08 -06005093 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005094 if (!image_entry) {
5095 return skip;
5096 }
5097
Mark Lobodzinski6f358172019-10-02 11:09:12 -06005098 // Image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
5099 if (device_extensions.vk_ext_image_drm_format_modifier) {
5100 if ((image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) &&
5101 (image_entry->createInfo.tiling != VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT)) {
5102 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5103 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-02270",
5104 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR or "
5105 "VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.");
5106 }
5107 } else {
5108 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
5109 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5110 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-image-00996",
5111 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
5112 }
Mike Weiblen672b58b2017-02-21 14:32:53 -07005113 }
5114
Dave Houlton1d960ff2018-01-19 12:17:05 -07005115 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005116 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005117 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5118 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5119 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5120 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005121 }
5122
Dave Houlton1d960ff2018-01-19 12:17:05 -07005123 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005124 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005125 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5126 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5127 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5128 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005129 }
5130
Dave Houlton1d960ff2018-01-19 12:17:05 -07005131 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005132 const VkFormat img_format = image_entry->createInfo.format;
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005133 if (image_entry->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
5134 if (FormatIsMultiplane(img_format)) {
5135 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
5136 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
5137 if (FormatPlaneCount(img_format) > 2u) {
5138 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
5139 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
5140 }
5141 if (sub_aspect != (sub_aspect & allowed_flags)) {
5142 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5143 HandleToUint64(image), vuid,
5144 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
5145 ") must be a single-plane specifier flag.",
5146 sub_aspect);
5147 }
5148 } else if (FormatIsColor(img_format)) {
5149 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
5150 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
5151 HandleToUint64(image), kVUID_Core_DrawState_InvalidImageAspect,
5152 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be "
5153 "VK_IMAGE_ASPECT_COLOR.");
5154 }
5155 } else if (FormatIsDepthOrStencil(img_format)) {
5156 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
5157 }
Dave Houlton1d960ff2018-01-19 12:17:05 -07005158 }
Mark Lobodzinski9824cac2019-10-02 13:19:38 -06005159 } else if (image_entry->createInfo.tiling == VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT) {
5160 if ((sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT) &&
5161 (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT) && (sub_aspect != VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT)) {
5162 // TODO: This VU also needs to ensure that the DRM index is in range and valid.
Dave Houlton1d960ff2018-01-19 12:17:05 -07005163 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 -06005164 HandleToUint64(image), "VUID-vkGetImageSubresourceLayout-tiling-02271",
5165 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must be "
5166 "VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005167 }
5168 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005169
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005170 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005171 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005172 }
5173
Mike Weiblen672b58b2017-02-21 14:32:53 -07005174 return skip;
5175}