blob: 5bf43c18f58a4366af71c76b4110e74c8c7e93cc [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
115bool IMAGE_STATE::IsCompatibleAliasing(IMAGE_STATE *other_image_state) {
116 if (!(createInfo.flags & other_image_state->createInfo.flags & VK_IMAGE_CREATE_ALIAS_BIT)) return false;
117 if ((create_from_swapchain == VK_NULL_HANDLE) && (binding.mem == other_image_state->binding.mem) &&
118 (binding.mem != VK_NULL_HANDLE) && (binding.offset == other_image_state->binding.offset) &&
119 IsCreateInfoEqual(other_image_state->createInfo)) {
120 return true;
121 }
unknowne1661522019-07-11 13:04:18 -0600122 if ((bind_swapchain == other_image_state->bind_swapchain) && (bind_swapchain != VK_NULL_HANDLE)) {
123 return true;
124 }
unknown2c877272019-07-11 12:56:50 -0600125 return false;
126}
127
John Zulauff660ad62019-03-23 07:16:05 -0600128IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
129 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
130 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
131 if (conversionInfo) samplerConversion = conversionInfo->conversion;
132 if (image_state) {
133 // A light normalization of the createInfo range
134 auto &sub_res_range = create_info.subresourceRange;
135 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
136 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
137
138 // Cache a full normalization (for "full image/whole image" comparisons)
139 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
Jeff Bolz6cede832019-08-09 23:30:39 -0500140 samples = image_state->createInfo.samples;
141 descriptor_format_bits = DescriptorRequirementsBitsFromFormat(create_info.format);
John Zulauff660ad62019-03-23 07:16:05 -0600142 }
143}
144
Dave Houltond9611312018-11-19 17:03:36 -0700145uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
146 // uint cast applies floor()
147 return 1u + (uint32_t)log2(std::max({height, width, depth}));
148}
149
150uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
151
152uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
153
John Zulauff660ad62019-03-23 07:16:05 -0600154VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
155 const VkImageCreateInfo &image_create_info = image_state.createInfo;
156 VkImageSubresourceRange norm = range;
157 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
158
159 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
160 // <arrayLayers> can potentially alias.
161 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
162 ? image_create_info.extent.depth
163 : image_create_info.arrayLayers;
164 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
165
166 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
167 VkImageAspectFlags &aspect_mask = norm.aspectMask;
168 if (FormatIsMultiplane(image_create_info.format)) {
169 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
170 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
171 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
172 if (FormatPlaneCount(image_create_info.format) > 2) {
173 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
174 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700175 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700176 }
John Zulauff660ad62019-03-23 07:16:05 -0600177 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700178}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700179
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700180template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700181void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700182 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700183 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
184 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
185 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
186 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600187 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700188 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
189 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
190 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700191 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700192}
193
194template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700195void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700196 if (imgpair.subresource.aspectMask & aspectMask) {
197 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700198 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700199 }
200}
201
Tony Barbourdf013b92017-01-25 12:53:48 -0700202// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600203void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700204 auto it = imageLayoutMap.find(imgpair);
205 if (it != imageLayoutMap.end()) {
206 it->second.layout = layout; // Update
207 } else {
208 imageLayoutMap[imgpair].layout = layout; // Insert
209 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700210}
211
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700212bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700213 if (!(imgpair.subresource.aspectMask & aspectMask)) {
214 return false;
215 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700216 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
217 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600218 auto imgsubIt = imageLayoutMap.find(imgpair);
219 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700220 return false;
221 }
222 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200223 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 -0600224 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600225 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700226 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700227 string_VkImageLayout(imgsubIt->second.layout));
228 }
229 layout = imgsubIt->second.layout;
230 return true;
231}
232
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700233// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700234bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700235 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700236 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
237 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
238 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
239 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600240 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700241 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
242 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
243 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700244 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700245 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
246 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600247 auto imgsubIt = imageLayoutMap.find(imgpair);
248 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700249 layout = imgsubIt->second.layout;
250 }
251 return true;
252}
253
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700254bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600255 auto sub_data = imageSubresourceMap.find(image);
256 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700257 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700258 if (!image_state) return false;
259 bool ignoreGlobal = false;
260 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
261 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
262 ignoreGlobal = true;
263 }
264 for (auto imgsubpair : sub_data->second) {
265 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600266 auto img_data = imageLayoutMap.find(imgsubpair);
267 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700268 layouts.push_back(img_data->second.layout);
269 }
270 }
271 return true;
272}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700273
John Zulauf3b04ebd2019-07-18 14:08:11 -0600274bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
275 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700276 if (!(imgpair.subresource.aspectMask & aspectMask)) {
277 return false;
278 }
279 imgpair.subresource.aspectMask = aspectMask;
280 auto imgsubIt = imageLayoutMap.find(imgpair);
281 if (imgsubIt == imageLayoutMap.end()) {
282 return false;
283 }
284 layout = imgsubIt->second.layout;
285 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700286}
Tony Barbourdf013b92017-01-25 12:53:48 -0700287
288// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600289bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
290 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700291 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
292 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
293 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
294 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
295 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600296 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700297 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
298 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
299 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
300 }
301 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700302 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
303 imgpair = {imgpair.image, false, VkImageSubresource()};
304 auto imgsubIt = imageLayoutMap.find(imgpair);
305 if (imgsubIt == imageLayoutMap.end()) return false;
306 layout = imgsubIt->second.layout;
307 }
308 return true;
309}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310
311// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700312void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700313 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600314 auto data = imageLayoutMap.find(imgpair);
315 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700316 data->second.layout = layout; // Update
317 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600318 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700319 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600320 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700321 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
322 if (subresource == image_subresources.end()) {
323 image_subresources.push_back(imgpair);
324 }
325}
326
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600327// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600328void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600329 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
330 VkImageLayout expected_layout) {
331 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
332 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600333 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600334 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700335 }
336}
John Zulauff660ad62019-03-23 07:16:05 -0600337
338// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600339void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500340 if (disabled.image_layout_validation) {
341 return;
342 }
John Zulauff660ad62019-03-23 07:16:05 -0600343 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
344 if (image_state) {
345 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600346 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600347 }
348}
349
350// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600351void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600352 const VkImageSubresourceRange &range, VkImageLayout layout) {
353 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
354 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600355 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600356}
357
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600358void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600359 VkImageLayout layout) {
360 const IMAGE_STATE *image_state = GetImageState(image);
361 if (!image_state) return;
362 SetImageInitialLayout(cb_node, *image_state, range, layout);
363};
364
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600365void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600366 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
367 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600368}
Dave Houltonddd65c52018-05-08 14:58:01 -0600369
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600370// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600371void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600372 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
373 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600374
John Zulauff660ad62019-03-23 07:16:05 -0600375 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600376 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
377 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600378 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 -0600379 sub_range.baseArrayLayer = 0;
380 sub_range.layerCount = image_state->createInfo.extent.depth;
381 }
382
John Zulauff660ad62019-03-23 07:16:05 -0600383 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600384}
385
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700386bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
387 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700388 VkFramebuffer framebuffer, VkRenderPass renderpass,
John Zulauf17a01bb2019-08-09 16:41:19 -0600389 uint32_t attachment_index, const char *variable_name) const {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100390 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700391 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100392 const char *vuid;
393 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
394
395 if (!image_state) {
396 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
397 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600398 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700399 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
400 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100401 return skip;
402 }
403
404 auto image_usage = image_state->createInfo.usage;
405
406 // Check for layouts that mismatch image usages in the framebuffer
407 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
408 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
409 skip |=
410 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 -0600411 "Layout/usage mismatch for attachment %u in %s"
412 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100413 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600414 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
415 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100416 }
417
418 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
419 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
420 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
421 skip |=
422 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 -0600423 "Layout/usage mismatch for attachment %u in %s"
424 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100425 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600426 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
427 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100428 }
429
430 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
431 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
432 skip |=
433 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 -0600434 "Layout/usage mismatch for attachment %u in %s"
435 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600437 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
438 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100439 }
440
441 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
442 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
443 skip |=
444 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 -0600445 "Layout/usage mismatch for attachment %u in %s"
446 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100447 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600448 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
449 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 }
451
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600452 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
454 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
455 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
456 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
457 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
458 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700459 skip |= log_msg(
460 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"
Lockee9aeebf2019-03-03 23:50:08 -0700463 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_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 } else {
468 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
469 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
470 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
471 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
472 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
473 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600474 "Layout/usage mismatch for attachment %u in %s"
475 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100476 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600477 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
478 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700479 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100480 }
481 }
482 return skip;
483}
484
John Zulauf17a01bb2019-08-09 16:41:19 -0600485bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, const CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700486 const VkRenderPassBeginInfo *pRenderPassBegin,
John Zulauf17a01bb2019-08-09 16:41:19 -0600487 const FRAMEBUFFER_STATE *framebuffer_state) const {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600488 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700489 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700490 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100491 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100492
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700493 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100494 auto framebuffer = framebuffer_state->framebuffer;
495
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700496 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600497 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 -0600498 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700499 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700500 }
John Zulauf8e308292018-09-21 11:34:37 -0600501
Tobias Hectorc9057422019-07-23 12:15:52 +0100502 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
503 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
504 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100505 }
506
Tobias Hectorc9057422019-07-23 12:15:52 +0100507 if (attachments != nullptr) {
508 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
509 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
510 auto image_view = attachments[i];
511 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100512
Tobias Hectorc9057422019-07-23 12:15:52 +0100513 if (!view_state) {
514 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
515 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
516 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
517 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
518 report_data->FormatHandle(image_view).c_str());
519 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100520 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100521
522 const VkImage image = view_state->create_info.image;
523 const IMAGE_STATE *image_state = GetImageState(image);
524
525 if (!image_state) {
526 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
527 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
528 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
529 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
530 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
531 continue;
532 }
533 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
534 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
535
536 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
537 // in common with the non-const version.)
538 const ImageSubresourceLayoutMap *subresource_map =
539 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
540
541 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
542 LayoutUseCheckAndMessage layout_check(subresource_map);
543 bool subres_skip = false;
544 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
545 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
546 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
547 subres_skip |=
548 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
549 kVUID_Core_DrawState_InvalidRenderpass,
550 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
551 "and the %s layout of the attachment is %s. The layouts must match, or the render "
552 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
553 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
554 string_VkImageLayout(layout_check.layout));
555 }
556 return !subres_skip; // quit checking subresources once we fail once
557 };
558
559 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
560 skip |= subres_skip;
561 }
562
563 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
564 framebuffer, render_pass, i, "initial layout");
565
566 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
567 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100568 }
569
Tobias Hectorc9057422019-07-23 12:15:52 +0100570 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
571 auto &subpass = pRenderPassInfo->pSubpasses[j];
572 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
573 auto &attachment_ref = subpass.pInputAttachments[k];
574 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
575 auto image_view = attachments[attachment_ref.attachment];
576 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100577
Tobias Hectorc9057422019-07-23 12:15:52 +0100578 if (view_state) {
579 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700580 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
581 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100582 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100583 }
584 }
585 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100586
Tobias Hectorc9057422019-07-23 12:15:52 +0100587 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
588 auto &attachment_ref = subpass.pColorAttachments[k];
589 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
590 auto image_view = attachments[attachment_ref.attachment];
591 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100592
Tobias Hectorc9057422019-07-23 12:15:52 +0100593 if (view_state) {
594 auto image = view_state->create_info.image;
595 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
596 framebuffer, render_pass, attachment_ref.attachment,
597 "color attachment layout");
598 if (subpass.pResolveAttachments) {
599 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
600 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
601 attachment_ref.attachment, "resolve attachment layout");
602 }
603 }
604 }
605 }
606
607 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
608 auto &attachment_ref = *subpass.pDepthStencilAttachment;
609 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
610 auto image_view = attachments[attachment_ref.attachment];
611 auto view_state = GetImageViewState(image_view);
612
613 if (view_state) {
614 auto image = view_state->create_info.image;
615 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
616 framebuffer, render_pass, attachment_ref.attachment,
617 "input attachment layout");
618 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100619 }
620 }
621 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700622 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600623 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700624}
625
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600626void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700627 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700628 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700629 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600630 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600631 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600632 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700633 }
634}
635
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600636void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
637 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700638 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700639
640 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700641 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700642 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700643 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700644 }
645 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700646 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700647 }
648 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700649 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700650 }
651 }
652}
653
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700654// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
655// 1. Transition into initialLayout state
656// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600657void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700658 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700659 // First transition into initialLayout
660 auto const rpci = render_pass_state->createInfo.ptr();
661 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700662 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600663 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600664 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600665 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700666 }
667 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700668 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700669}
670
Dave Houlton10b39482017-03-16 13:18:15 -0600671bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600672 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600673 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600674 }
675 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600676 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600677 }
678 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600679 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600680 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700681 if (0 !=
682 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
683 if (FormatPlaneCount(format) == 1) return false;
684 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600685 return true;
686}
687
Mike Weiblen62d08a32017-03-07 22:18:27 -0700688// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200689bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
690 VkImageUsageFlags usage_flags, const char *func_name,
John Zulaufa4472282019-08-22 14:44:34 -0600691 const char *barrier_pname) const {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700692 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200693 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600694 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695
696 switch (layout) {
697 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
698 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600699 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700 }
701 break;
702 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
703 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600704 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700705 }
706 break;
707 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
708 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600709 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700710 }
711 break;
712 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
713 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600714 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700715 }
716 break;
717 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
718 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600719 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700720 }
721 break;
722 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
723 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600724 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700725 }
726 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600727 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500728 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
729 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
730 }
731 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700732 default:
733 // Other VkImageLayout values do not have VUs defined in this context.
734 break;
735 }
736
Dave Houlton8e9f6542018-05-18 12:18:22 -0600737 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600738 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 +0200739 HandleToUint64(img_barrier.image), msg_code,
740 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
741 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
742 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700743 }
744 return skip;
745}
746
747// Verify image barriers are compatible with the images they reference.
John Zulaufa4472282019-08-22 14:44:34 -0600748bool CoreChecks::ValidateBarriersToImages(const CMD_BUFFER_STATE *cb_state, uint32_t imageMemoryBarrierCount,
749 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) const {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700750 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700751
Petr Krausad0096a2019-08-09 18:35:04 +0200752 // Scoreboard for checking for duplicate and inconsistent barriers to images
753 struct ImageBarrierScoreboardEntry {
754 uint32_t index;
755 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
756 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
757 const VkImageMemoryBarrier *barrier;
758 };
759 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
760 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
761
John Zulauf463c51e2018-05-31 13:29:20 -0600762 // Scoreboard for duplicate layout transition barriers within the list
763 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
764 ImageBarrierScoreboardImageMap layout_transitions;
765
Mike Weiblen62d08a32017-03-07 22:18:27 -0700766 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200767 const auto &img_barrier = pImageMemoryBarriers[i];
768 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700769
John Zulauf463c51e2018-05-31 13:29:20 -0600770 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
771 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
772 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200773 if (img_barrier.oldLayout != img_barrier.newLayout) {
774 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
775 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600776 if (image_it != layout_transitions.end()) {
777 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200778 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600779 if (subres_it != subres_map.end()) {
780 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200781 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
782 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
783 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600784 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700785 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
786 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200787 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600788 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
789 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200790 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
791 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
792 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600793 }
794 entry = new_entry;
795 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200796 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600797 }
798 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200799 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600800 }
801 }
802
Petr Krausad0096a2019-08-09 18:35:04 +0200803 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600804 if (image_state) {
805 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200806 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
807 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600808
809 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
810 if (image_state->layout_locked) {
811 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600812 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700813 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200814 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600815 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600816 " 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 +0200817 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
818 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600819 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600820
John Zulaufa4472282019-08-22 14:44:34 -0600821 const VkImageCreateInfo &image_create_info = image_state->createInfo;
John Zulauff660ad62019-03-23 07:16:05 -0600822 // For a Depth/Stencil image both aspects MUST be set
John Zulaufa4472282019-08-22 14:44:34 -0600823 if (FormatIsDepthAndStencil(image_create_info.format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200824 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600825 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
826 if ((aspect_mask & ds_mask) != (ds_mask)) {
827 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 +0200828 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-01207",
829 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600830 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200831 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulaufa4472282019-08-22 14:44:34 -0600832 string_VkFormat(image_create_info.format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700833 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700834 }
John Zulauff660ad62019-03-23 07:16:05 -0600835
Petr Krausad0096a2019-08-09 18:35:04 +0200836 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
837 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600838 // TODO: Set memory invalid which is in mem_tracker currently
839 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
840 // subresource.
841 } else if (subresource_map) {
842 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600843 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200844 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600845 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600846 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200847 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600848 subres_skip =
849 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
850 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600851 "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 -0600852 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200853 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
854 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600855 string_VkImageLayout(layout_check.layout));
856 }
857 return !subres_skip;
858 };
859 subresource_map->ForRange(normalized_isr, subres_callback);
860 skip |= subres_skip;
861 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700862 }
863 }
864 return skip;
865}
866
John Zulaufe3d1c8a2019-08-12 14:34:58 -0600867bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) const {
Petr Krausad0096a2019-08-09 18:35:04 +0200868 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700869
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600870 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
Petr Krausad0096a2019-08-09 18:35:04 +0200871 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700872}
873
John Zulauf6b4aae82018-05-09 13:03:36 -0600874template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600875bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
876 uint32_t barrier_count, const Barrier *barriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600877 using BarrierRecord = QFOTransferBarrier<Barrier>;
878 bool skip = false;
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600879 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600880 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
881 const char *barrier_name = BarrierRecord::BarrierName();
882 const char *handle_name = BarrierRecord::HandleName();
883 const char *transfer_type = nullptr;
884 for (uint32_t b = 0; b < barrier_count; b++) {
885 if (!IsTransferOp(&barriers[b])) continue;
886 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700887 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600888 !QueueFamilyIsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600889 const auto found = barrier_sets.release.find(barriers[b]);
890 if (found != barrier_sets.release.cend()) {
891 barrier_record = &(*found);
892 transfer_type = "releasing";
893 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600894 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
John Zulaufa4472282019-08-22 14:44:34 -0600895 !QueueFamilyIsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600896 const auto found = barrier_sets.acquire.find(barriers[b]);
897 if (found != barrier_sets.acquire.cend()) {
898 barrier_record = &(*found);
899 transfer_type = "acquiring";
900 }
901 }
902 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700903 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
904 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
905 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
906 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
907 func_name, barrier_name, b, transfer_type, handle_name,
908 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
909 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600910 }
911 }
912 return skip;
913}
914
John Zulaufa4472282019-08-22 14:44:34 -0600915VulkanTypedHandle BarrierTypedHandle(const VkImageMemoryBarrier &barrier) {
916 return VulkanTypedHandle(barrier.image, kVulkanObjectTypeImage);
917}
918
919const IMAGE_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkImageMemoryBarrier &barrier) {
920 return device_state.GetImageState(barrier.image);
921}
922
923VulkanTypedHandle BarrierTypedHandle(const VkBufferMemoryBarrier &barrier) {
924 return VulkanTypedHandle(barrier.buffer, kVulkanObjectTypeBuffer);
925}
926
927const BUFFER_STATE *BarrierHandleState(const ValidationStateTracker &device_state, const VkBufferMemoryBarrier &barrier) {
928 return device_state.GetBufferState(barrier.buffer);
929}
930
931VkBuffer BarrierHandle(const VkBufferMemoryBarrier &barrier) { return barrier.buffer; }
932
John Zulauf6b4aae82018-05-09 13:03:36 -0600933template <typename Barrier>
John Zulaufa4472282019-08-22 14:44:34 -0600934void CoreChecks::RecordBarrierArrayValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
935 const Barrier *barriers) {
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600936 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600937 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
938 for (uint32_t b = 0; b < barrier_count; b++) {
John Zulaufa4472282019-08-22 14:44:34 -0600939 auto &barrier = barriers[b];
940 if (IsTransferOp(&barrier)) {
941 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barrier) &&
942 !QueueFamilyIsSpecial(barrier.dstQueueFamilyIndex)) {
943 barrier_sets.release.emplace(barrier);
944 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barrier) &&
945 !QueueFamilyIsSpecial(barrier.srcQueueFamilyIndex)) {
946 barrier_sets.acquire.emplace(barrier);
947 }
948 }
949
950 const uint32_t src_queue_family = barrier.srcQueueFamilyIndex;
951 const uint32_t dst_queue_family = barrier.dstQueueFamilyIndex;
952 if (!QueueFamilyIsIgnored(src_queue_family) && !QueueFamilyIsIgnored(dst_queue_family)) {
953 // Only enqueue submit time check if it is needed. If more submit time checks are added, change the criteria
954 // TODO create a better named list, or rename the submit time lists to something that matches the broader usage...
955 auto handle_state = BarrierHandleState(*this, barrier);
956 bool mode_concurrent = handle_state ? handle_state->createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT : false;
957 if (!mode_concurrent) {
958 const auto typed_handle = BarrierTypedHandle(barrier);
959 cb_state->eventUpdates.emplace_back(
960 [this, func_name, cb_state, typed_handle, src_queue_family, dst_queue_family](VkQueue queue) {
961 return ValidateConcurrentBarrierAtSubmit(queue, func_name, cb_state, typed_handle, src_queue_family,
962 dst_queue_family);
963 });
964 }
John Zulauf6b4aae82018-05-09 13:03:36 -0600965 }
966 }
967}
968
John Zulaufa4472282019-08-22 14:44:34 -0600969bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600970 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700971 uint32_t imageMemBarrierCount,
John Zulaufa4472282019-08-22 14:44:34 -0600972 const VkImageMemoryBarrier *pImageMemBarriers) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600973 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700974 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
975 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600976 return skip;
977}
978
John Zulaufa4472282019-08-22 14:44:34 -0600979void CoreChecks::RecordBarrierValidationInfo(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
980 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
981 const VkImageMemoryBarrier *pImageMemBarriers) {
982 RecordBarrierArrayValidationInfo(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
983 RecordBarrierArrayValidationInfo(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600984}
985
986template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600987bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600988 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600989 // Record to the scoreboard or report that we have a duplication
990 bool skip = false;
991 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
992 if (!inserted.second && inserted.first->second != cb_state) {
993 // 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 -0700994 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
995 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
996 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -0600997 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -0700998 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
999 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -06001000 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -06001001 }
1002 return skip;
1003}
1004
1005template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -06001006bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
1007 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001008 using BarrierRecord = QFOTransferBarrier<Barrier>;
1009 using TypeTag = typename BarrierRecord::Tag;
1010 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -06001011 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001012 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001013 const char *barrier_name = BarrierRecord::BarrierName();
1014 const char *handle_name = BarrierRecord::HandleName();
1015 // No release should have an extant duplicate (WARNING)
1016 for (const auto &release : cb_barriers.release) {
1017 // Check the global pending release barriers
1018 const auto set_it = global_release_barriers.find(release.handle);
1019 if (set_it != global_release_barriers.cend()) {
1020 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1021 const auto found = set_for_handle.find(release);
1022 if (found != set_for_handle.cend()) {
1023 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1024 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -07001025 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -06001026 " to dstQueueFamilyIndex %" PRIu32
1027 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -07001028 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001029 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
1030 }
1031 }
1032 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
1033 }
1034 // Each acquire must have a matching release (ERROR)
1035 for (const auto &acquire : cb_barriers.acquire) {
1036 const auto set_it = global_release_barriers.find(acquire.handle);
1037 bool matching_release_found = false;
1038 if (set_it != global_release_barriers.cend()) {
1039 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1040 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
1041 }
1042 if (!matching_release_found) {
1043 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1044 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -07001045 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
1046 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
1047 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -06001048 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1049 }
1050 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1051 }
1052 return skip;
1053}
1054
John Zulauf3b04ebd2019-07-18 14:08:11 -06001055bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001056 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -06001057 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -06001058 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001059 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
1060 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -06001061 return skip;
1062}
1063
1064template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001065void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001066 using BarrierRecord = QFOTransferBarrier<Barrier>;
1067 using TypeTag = typename BarrierRecord::Tag;
1068 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001069 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001070
1071 // Add release barriers from this submit to the global map
1072 for (const auto &release : cb_barriers.release) {
1073 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1074 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1075 global_release_barriers[release.handle].insert(release);
1076 }
1077
1078 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1079 for (const auto &acquire : cb_barriers.acquire) {
1080 // NOTE: We're not using [] because we don't want to create entries for missing releases
1081 auto set_it = global_release_barriers.find(acquire.handle);
1082 if (set_it != global_release_barriers.end()) {
1083 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1084 set_for_handle.erase(acquire);
1085 if (set_for_handle.size() == 0) { // Clean up empty sets
1086 global_release_barriers.erase(set_it);
1087 }
1088 }
1089 }
1090}
1091
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001092void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001093 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1094 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001095}
1096
John Zulauf6b4aae82018-05-09 13:03:36 -06001097// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001098void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001099
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001100void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001101 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001102 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001103 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001104
Chris Forbes4de4b132017-08-21 11:27:08 -07001105 // For ownership transfers, the barrier is specified twice; as a release
1106 // operation on the yielding queue family, and as an acquire operation
1107 // on the acquiring queue family. This barrier may also include a layout
1108 // transition, which occurs 'between' the two operations. For validation
1109 // purposes it doesn't seem important which side performs the layout
1110 // transition, but it must not be performed twice. We'll arbitrarily
1111 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001112 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001113 continue;
1114 }
1115
Petr Krausad0096a2019-08-09 18:35:04 +02001116 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001117 if (!image_state) continue;
1118
Petr Krausad0096a2019-08-09 18:35:04 +02001119 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
John Zulauff660ad62019-03-23 07:16:05 -06001120 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001121
Dave Houltonb3f4b282018-02-22 16:25:16 -07001122 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1123 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1124 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001125 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1126 normalized_isr.baseArrayLayer = 0;
1127 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001128 }
1129
Petr Krausad0096a2019-08-09 18:35:04 +02001130 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001131 }
1132}
1133
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001134bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1135 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1136 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1137 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001138 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001139 assert(cb_node);
1140 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001141 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001142 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001143
John Zulauff660ad62019-03-23 07:16:05 -06001144 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1145 if (subresource_map) {
1146 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001147 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1148 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001149 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001150 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001151 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001152 subres_skip |=
1153 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1154 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001155 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001156 "%s layout %s.",
1157 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1158 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001159 }
John Zulauff660ad62019-03-23 07:16:05 -06001160 return !subres_skip;
1161 };
1162 subresource_map->ForRange(range, subresource_cb);
1163 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001164 }
John Zulauff660ad62019-03-23 07:16:05 -06001165
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001166 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1167 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1168 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001169 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1170 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001171 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001172 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001173 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001174 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001175 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001176 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001177 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001178 if (image_state->shared_presentable) {
1179 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1181 layout_invalid_msg_code,
1182 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1183 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001184 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001185 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001186 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001187 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001188 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 -07001189 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001190 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001191 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1192 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001193 }
1194 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001195 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001196}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001197bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001198 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1199 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001200 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001201 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1202 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1203}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001204
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001205void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001206 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001207 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001208 if (!renderPass) return;
1209
Tobias Hectorbbb12282018-10-22 15:17:59 +01001210 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001211 if (framebuffer_state) {
1212 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001213 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001214 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001215 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001216 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001217 }
1218 }
1219}
Dave Houltone19e20d2018-02-02 16:32:41 -07001220
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001221#ifdef VK_USE_PLATFORM_ANDROID_KHR
1222// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1223// This could also move into a seperate core_validation_android.cpp file... ?
1224
1225//
1226// AHB-specific validation within non-AHB APIs
1227//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001228bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001229 bool skip = false;
1230
1231 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1232 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001233 if (0 != ext_fmt_android->externalFormat) {
1234 if (VK_FORMAT_UNDEFINED != create_info->format) {
1235 skip |=
1236 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1237 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001238 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001239 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1240 }
1241
1242 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1243 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1244 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001245 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001246 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1247 }
1248
1249 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1250 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1251 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001252 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001253 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1254 }
1255
1256 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1257 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1258 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001259 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001260 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1261 }
1262 }
1263
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001264 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001265 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1266 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001267 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001268 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1269 }
1270 }
1271
Dave Houltond9611312018-11-19 17:03:36 -07001272 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001273 if (VK_FORMAT_UNDEFINED == create_info->format) {
1274 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1275 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001276 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001277 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1278 }
1279 }
1280
1281 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1282 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1283 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001284 skip |=
1285 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1286 "VUID-VkImageCreateInfo-pNext-02393",
1287 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1288 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1289 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001290 }
1291
1292 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1293 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1294 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001295 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001296 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1297 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1298 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1299 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300 }
1301
1302 return skip;
1303}
1304
John Zulauf7eeb6f72019-06-17 11:56:36 -06001305void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001306 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1307 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1308 is_node->imported_ahb = true;
1309 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001310 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001311 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001312 is_node->has_ahb_format = true;
1313 is_node->ahb_format = ext_fmt_android->externalFormat;
1314 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001315}
1316
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001317bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001319 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001320
1321 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001322 if (VK_FORMAT_UNDEFINED != create_info->format) {
1323 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1324 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1325 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1326 "format member is %s.",
1327 string_VkFormat(create_info->format));
1328 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001329
Dave Houltond9611312018-11-19 17:03:36 -07001330 // Chain must include a compatible ycbcr conversion
1331 bool conv_found = false;
1332 uint64_t external_format = 0;
1333 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1334 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001335 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001336 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001337 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001338 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001339 }
Dave Houltond9611312018-11-19 17:03:36 -07001340 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001341 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001342 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 -07001343 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1344 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1345 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1346 }
1347
1348 // Errors in create_info swizzles
1349 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1350 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1351 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1352 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1353 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1354 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1355 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1356 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001357 }
1358 }
Dave Houltond9611312018-11-19 17:03:36 -07001359
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001360 return skip;
1361}
1362
John Zulaufa26d3c82019-08-14 16:09:08 -06001363bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001364 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001365
John Zulaufa26d3c82019-08-14 16:09:08 -06001366 const IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001367 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1368 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1369 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001370 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001371 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1372 "bound to memory.");
1373 }
1374 return skip;
1375}
1376
1377#else
1378
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001379bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001380 return false;
1381}
1382
John Zulauf7eeb6f72019-06-17 11:56:36 -06001383void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001384
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001385bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001386
John Zulaufa26d3c82019-08-14 16:09:08 -06001387bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) const { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001388
1389#endif // VK_USE_PLATFORM_ANDROID_KHR
1390
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001391bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1392 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001393 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001394
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001395 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001396 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001397 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1398 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1399 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1400 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001401 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001402 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001403 }
1404
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001405 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1406 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1407 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1408 "VUID-VkImageCreateInfo-flags-00949",
1409 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1410 "flag bit is set");
1411 }
1412
1413 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1415 "VUID-VkImageCreateInfo-imageType-00954",
1416 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1417 "height (%d) and arrayLayers (%d) must be >= 6.",
1418 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1419 }
Dave Houlton130c0212018-01-29 13:39:56 -07001420 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001421
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001422 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001423 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1424 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1425 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001426 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 +00001427 "VUID-VkImageCreateInfo-usage-00964",
1428 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1429 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001430 }
1431
1432 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001433 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 +00001434 "VUID-VkImageCreateInfo-usage-00965",
1435 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1436 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001437 }
1438
ByumjinConffx991b6062019-08-14 15:17:53 -07001439 if (device_extensions.vk_ext_fragment_density_map) {
1440 uint32_t ceiling_width =
1441 (uint32_t)ceil((float)device_limits->maxFramebufferWidth /
1442 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, 1.0f));
1443 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.width > ceiling_width)) {
1444 skip |=
1445 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1446 "VUID-VkImageCreateInfo-usage-02559",
1447 "vkCreateImage(): Image usage flags include a fragment density map bit and image width (%u) exceeds the "
1448 "ceiling of device "
1449 "maxFramebufferWidth (%u) / minFragmentDensityTexelSize.width (%u). The ceiling value: %u",
1450 pCreateInfo->extent.width, device_limits->maxFramebufferWidth,
1451 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.width, ceiling_width);
1452 }
1453
1454 uint32_t ceiling_height =
1455 (uint32_t)ceil((float)device_limits->maxFramebufferHeight /
1456 std::max((float)phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, 1.0f));
1457 if ((pCreateInfo->usage & VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT) && (pCreateInfo->extent.height > ceiling_height)) {
1458 skip |=
1459 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1460 "VUID-VkImageCreateInfo-usage-02560",
1461 "vkCreateImage(): Image usage flags include a fragment density map bit and image height (%u) exceeds the "
1462 "ceiling of device "
1463 "maxFramebufferHeight (%u) / minFragmentDensityTexelSize.height (%u). The ceiling value: %u",
1464 pCreateInfo->extent.height, device_limits->maxFramebufferHeight,
1465 phys_dev_ext_props.fragment_density_map_props.minFragmentDensityTexelSize.height, ceiling_height);
1466 }
1467 }
1468
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001469 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001470 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001471 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001472#ifdef VK_USE_PLATFORM_ANDROID_KHR
1473 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1474#endif // VK_USE_PLATFORM_ANDROID_KHR
1475 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1476 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1477 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001478 } else {
1479 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1480 const char *format_string = string_VkFormat(pCreateInfo->format);
1481 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1482 "VUID-VkImageCreateInfo-mipLevels-02255",
1483 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1484 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1485 }
Dave Houlton130c0212018-01-29 13:39:56 -07001486
Dave Houltona585d132019-01-18 13:05:42 -07001487 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1488 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1489 (uint64_t)pCreateInfo->samples;
1490 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001491
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001492 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001493 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001494 uint64_t ig_mask = imageGranularity - 1;
1495 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001496
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001497 if (total_size > format_limits.maxResourceSize) {
1498 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1499 kVUID_Core_Image_InvalidFormatLimitsViolation,
1500 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1501 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1502 total_size, format_limits.maxResourceSize);
1503 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001504
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001505 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1506 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1507 "VUID-VkImageCreateInfo-arrayLayers-02256",
1508 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1509 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1510 }
1511
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001512 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1513 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001514 skip |= log_msg(
1515 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1516 "VUID-VkImageCreateInfo-format-02653",
1517 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1518 pCreateInfo->arrayLayers);
1519 }
1520
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001521 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1522 skip |=
1523 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1524 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001525 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001526 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001527 }
1528
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001529 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001530 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 -06001531 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001532 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1533 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001534 }
1535
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001536 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001537 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1538 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1539 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1540 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001541 skip |=
1542 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1543 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1544 "format must be block, ETC or ASTC compressed, but is %s",
1545 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001546 }
1547 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1548 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001549 skip |=
1550 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1551 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1552 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001553 }
1554 }
1555 }
1556
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001557 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001558 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1559 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1560 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001561 }
1562
unknown2c877272019-07-11 12:56:50 -06001563 if (!FormatIsMultiplane(pCreateInfo->format) && !(pCreateInfo->flags & VK_IMAGE_CREATE_ALIAS_BIT) &&
1564 (pCreateInfo->flags & VK_IMAGE_CREATE_DISJOINT_BIT)) {
1565 skip |=
1566 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1567 "VUID-VkImageCreateInfo-format-01577",
1568 "vkCreateImage(): format is %s and flags are %s. The flags should not include VK_IMAGE_CREATE_DISJOINT_BIT.",
1569 string_VkFormat(pCreateInfo->format), string_VkImageCreateFlags(pCreateInfo->flags).c_str());
1570 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001571 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001572}
1573
John Zulauf7eeb6f72019-06-17 11:56:36 -06001574void ValidationStateTracker::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1575 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001576 if (VK_SUCCESS != result) return;
John Zulauf4db45df2019-07-23 06:10:40 -06001577 std::unique_ptr<IMAGE_STATE> is_node(new IMAGE_STATE(*pImage, pCreateInfo));
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001578 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
John Zulauf4db45df2019-07-23 06:10:40 -06001579 RecordCreateImageANDROID(pCreateInfo, is_node.get());
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001580 }
unknown09edc722019-06-21 15:49:38 -06001581 const auto swapchain_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1582 if (swapchain_info) {
1583 is_node->create_from_swapchain = swapchain_info->swapchain;
1584 }
John Zulauf4db45df2019-07-23 06:10:40 -06001585
1586 bool pre_fetch_memory_reqs = true;
1587#ifdef VK_USE_PLATFORM_ANDROID_KHR
1588 if (is_node->external_format_android) {
1589 // Do not fetch requirements for external memory images
1590 pre_fetch_memory_reqs = false;
1591 }
1592#endif
1593 // Record the memory requirements in case they won't be queried
1594 if (pre_fetch_memory_reqs) {
1595 DispatchGetImageMemoryRequirements(device, *pImage, &is_node->requirements);
1596 }
1597 imageMap.insert(std::make_pair(*pImage, std::move(is_node)));
John Zulauf7eeb6f72019-06-17 11:56:36 -06001598}
1599
1600void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1601 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1602 if (VK_SUCCESS != result) return;
1603
1604 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1605
1606 IMAGE_LAYOUT_STATE image_state;
1607 image_state.layout = pCreateInfo->initialLayout;
1608 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001609 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001610 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001611 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001612}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001613
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001614bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001615 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001616 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001617 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001618 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001619 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001620 }
1621 return skip;
1622}
1623
John Zulauf7eeb6f72019-06-17 11:56:36 -06001624void ValidationStateTracker::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001625 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001626 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001627 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001628 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001629 // Clean up memory mapping, bindings and range references for image
1630 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06001631 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001632 if (mem_info) {
unknownf4cf0972019-08-15 16:42:02 -06001633 RemoveImageMemoryRange(image, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001634 }
1635 }
unknown2c877272019-07-11 12:56:50 -06001636 if (image_state->bind_swapchain) {
1637 auto swapchain = GetSwapchainState(image_state->bind_swapchain);
1638 if (swapchain) {
1639 swapchain->bound_images.erase(image_state->image);
1640 }
1641 }
1642 RemoveAliasingImage(image_state);
John Zulauf4fea6622019-04-01 11:38:18 -06001643 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001644 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001645 imageMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001646}
1647
1648void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1649 // Clean up validation specific data
1650 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001651
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001652 const auto &sub_entry = imageSubresourceMap.find(image);
1653 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001654 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001655 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001656 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001657 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001658 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001659
1660 // Clean up generic image state
1661 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001662}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001663
John Zulauf07288512019-07-05 11:09:50 -06001664bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001665 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001666
1667 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1668 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1669 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 -06001670 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001671 }
1672
Dave Houlton1d2022c2017-03-29 11:43:58 -06001673 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001674 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1675 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 -06001676 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001677 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001678 char const str[] = "vkCmdClearColorImage called with compressed image.";
1679 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 -06001680 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001681 }
1682
1683 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1684 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1685 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 -06001686 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001687 }
1688 return skip;
1689}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001691uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1692 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1693 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001694 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001695 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001696 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001697 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698}
1699
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001700uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1701 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1702 uint32_t array_layer_count = range->layerCount;
1703 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1704 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001705 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001706 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001707}
1708
John Zulauf07288512019-07-05 11:09:50 -06001709bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1710 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1711 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001713
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001714 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1715 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001716 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1717 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001718 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 -06001719 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001720 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1721 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001722 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001723 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001724 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001725 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 -06001726 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001727 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1728 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001729
1730 } else {
1731 if (image_state->shared_presentable) {
1732 skip |= log_msg(
1733 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001734 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001735 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1736 string_VkImageLayout(dest_image_layout));
1737 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001738 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001739 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001740 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001741 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001742 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001743 } else {
1744 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1745 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001746 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 -06001747 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001748 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1749 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001750 }
1751 }
1752
John Zulauff660ad62019-03-23 07:16:05 -06001753 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001754 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001755 if (subresource_map) {
1756 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001757 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001758 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001759 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001760 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001761 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001762 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1763 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1764 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1765 } else {
1766 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001767 }
John Zulauff660ad62019-03-23 07:16:05 -06001768 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1769 HandleToUint64(cb_node->commandBuffer), error_code,
1770 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1771 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1772 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001773 }
John Zulauff660ad62019-03-23 07:16:05 -06001774 return !subres_skip;
1775 };
1776 subresource_map->ForRange(normalized_isr, subres_callback);
1777 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001778 }
1779
1780 return skip;
1781}
1782
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001783bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1784 const VkClearColorValue *pColor, uint32_t rangeCount,
1785 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001786 bool skip = false;
1787 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001788 const auto *cb_node = GetCBState(commandBuffer);
1789 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001790 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001791 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001792 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001793 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001794 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001795 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001796 skip |=
1797 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1798 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001799 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001800 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001801 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001802 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001803 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001804 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1805 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001806 }
1807 }
1808 return skip;
1809}
1810
John Zulaufeabb4462019-07-05 14:13:03 -06001811void ValidationStateTracker::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image,
1812 VkImageLayout imageLayout, const VkClearColorValue *pColor,
1813 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001814 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001815 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001816 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001817 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001818 }
1819}
1820
1821void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1822 const VkClearColorValue *pColor, uint32_t rangeCount,
1823 const VkImageSubresourceRange *pRanges) {
1824 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1825
1826 auto cb_node = GetCBState(commandBuffer);
1827 auto image_state = GetImageState(image);
1828 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001829 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001830 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001831 }
1832 }
1833}
1834
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001835bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1836 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1837 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001838 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001839
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001840 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001841 const auto *cb_node = GetCBState(commandBuffer);
1842 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001843 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001844 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001845 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001846 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001847 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001848 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001849 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001850 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1851 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001852 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001853 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001854 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001855 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001856 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001857 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001858 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001859 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001860 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1861 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001862 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001863 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1864 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001865 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 -06001866 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001867 }
1868 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001869 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001870 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001871 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 -06001872 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001873 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001874 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1875 char const str[] =
1876 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1877 "set.";
1878 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 -06001879 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001880 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001881 }
1882 return skip;
1883}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001884
John Zulaufeabb4462019-07-05 14:13:03 -06001885void ValidationStateTracker::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
1886 VkImageLayout imageLayout,
1887 const VkClearDepthStencilValue *pDepthStencil,
1888 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001889 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001890 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001891 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001892 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001893 }
1894}
1895
1896void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1897 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1898 const VkImageSubresourceRange *pRanges) {
1899 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1900 auto cb_node = GetCBState(commandBuffer);
1901 auto image_state = GetImageState(image);
1902 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001903 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001904 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001905 }
1906 }
1907}
1908
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001909// Returns true if [x, xoffset] and [y, yoffset] overlap
1910static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1911 bool result = false;
1912 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1913 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1914
1915 if (intersection_max > intersection_min) {
1916 result = true;
1917 }
1918 return result;
1919}
1920
Dave Houltonc991cc92018-03-06 11:08:51 -07001921// Returns true if source area of first copy region intersects dest area of second region
1922// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1923static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001924 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001925
Dave Houltonc991cc92018-03-06 11:08:51 -07001926 // Separate planes within a multiplane image cannot intersect
1927 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001928 return result;
1929 }
1930
Dave Houltonc991cc92018-03-06 11:08:51 -07001931 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1932 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1933 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001934 result = true;
1935 switch (type) {
1936 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001937 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001938 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001939 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001940 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001941 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001942 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001943 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001944 break;
1945 default:
1946 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1947 assert(false);
1948 }
1949 }
1950 return result;
1951}
1952
Dave Houltonfc1a4052017-04-27 14:32:45 -06001953// Returns non-zero if offset and extent exceed image extents
1954static const uint32_t x_bit = 1;
1955static const uint32_t y_bit = 2;
1956static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001957static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001958 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001959 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001960 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1961 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001962 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001963 }
1964 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1965 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001966 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001967 }
1968 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1969 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001970 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001971 }
1972 return result;
1973}
1974
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001975// Test if two VkExtent3D structs are equivalent
1976static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1977 bool result = true;
1978 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1979 (extent->depth != other_extent->depth)) {
1980 result = false;
1981 }
1982 return result;
1983}
1984
Dave Houltonee281a52017-12-08 13:51:02 -07001985// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1986// Destination image texel extents must be adjusted by block size for the dest validation checks
1987VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1988 VkExtent3D adjusted_extent = extent;
1989 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001990 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001991 adjusted_extent.width /= block_size.width;
1992 adjusted_extent.height /= block_size.height;
1993 adjusted_extent.depth /= block_size.depth;
1994 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001995 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001996 adjusted_extent.width *= block_size.width;
1997 adjusted_extent.height *= block_size.height;
1998 adjusted_extent.depth *= block_size.depth;
1999 }
2000 return adjusted_extent;
2001}
2002
Dave Houlton6f9059e2017-05-02 17:15:13 -06002003// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002004static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
2005 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06002006
2007 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06002008 if (mip >= img->createInfo.mipLevels) {
2009 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06002010 }
Dave Houlton1150cf52017-04-27 14:38:11 -06002011
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002012 // 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 -06002013 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05002014
Dave Houltone48cd112019-01-03 17:01:18 -07002015 // If multi-plane, adjust per-plane extent
2016 if (FormatIsMultiplane(img->createInfo.format)) {
2017 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
2018 extent.width /= divisors.width;
2019 extent.height /= divisors.height;
2020 }
2021
Jeff Bolzef40fec2018-09-01 22:04:34 -05002022 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
2023 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06002024 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05002025 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
2026 } else {
2027 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
2028 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
2029 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
2030 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06002031
Dave Houlton6f9059e2017-05-02 17:15:13 -06002032 // Image arrays have an effective z extent that isn't diminished by mip level
2033 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06002034 extent.depth = img->createInfo.arrayLayers;
2035 }
2036
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 return extent;
2038}
2039
2040// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002041static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002042 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
2043}
2044
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002045// Test if the extent argument has any dimensions set to 0.
2046static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
2047 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
2048}
2049
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002050// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002051VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002052 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
2053 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06002054 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002055 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002056 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002057 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07002058 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002059 granularity.width *= block_size.width;
2060 granularity.height *= block_size.height;
2061 }
2062 }
2063 return granularity;
2064}
2065
2066// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
2067static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
2068 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06002069 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
2070 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002071 valid = false;
2072 }
2073 return valid;
2074}
2075
2076// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002077bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002078 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002079 bool skip = false;
2080 VkExtent3D offset_extent = {};
2081 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
2082 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
2083 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002084 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002085 // 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 -07002086 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002087 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 -04002088 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002089 "%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 "
2090 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002091 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002092 }
2093 } else {
2094 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
2095 // integer multiples of the image transfer granularity.
2096 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002097 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 -04002098 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002099 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
2100 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02002101 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
2102 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103 }
2104 }
2105 return skip;
2106}
2107
2108// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002109bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002110 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002111 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002112 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002113 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002114 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2115 // subresource extent.
2116 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002117 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 -04002118 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002119 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2120 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2121 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2122 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002123 }
2124 } else {
2125 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2126 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2127 // subresource extent dimensions.
2128 VkExtent3D offset_extent_sum = {};
2129 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2130 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2131 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002132 bool x_ok = true;
2133 bool y_ok = true;
2134 bool z_ok = true;
2135 switch (image_type) {
2136 case VK_IMAGE_TYPE_3D:
2137 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2138 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002139 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002140 case VK_IMAGE_TYPE_2D:
2141 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2142 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002143 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002144 case VK_IMAGE_TYPE_1D:
2145 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2146 (subresource_extent->width == offset_extent_sum.width));
2147 break;
2148 default:
2149 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2150 assert(false);
2151 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002153 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 -04002154 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002155 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2156 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2157 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2158 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2159 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2160 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002161 }
2162 }
2163 return skip;
2164}
2165
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002166bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002167 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002168 bool skip = false;
2169 if (mip_level >= img->createInfo.mipLevels) {
2170 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2171 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002172 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2173 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002174 }
2175 return skip;
2176}
2177
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002178bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002179 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002180 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002181 bool skip = false;
2182 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2183 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2184 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2185 HandleToUint64(cb_node->commandBuffer), vuid,
2186 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002187 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002188 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2189 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002190 }
2191 return skip;
2192}
2193
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002194// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002195bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002196 const VkBufferImageCopy *region, const uint32_t i,
John Zulaufe3d1c8a2019-08-12 14:34:58 -06002197 const char *function, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002198 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002199 VkExtent3D granularity = GetScaledItg(cb_node, img);
2200 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002201 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002202 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002203 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002204 return skip;
2205}
2206
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002207// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002208bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002209 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002210 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002211 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002212 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002213 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2214 skip |=
2215 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002217 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002218 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2219 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002221 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002222 granularity = GetScaledItg(cb_node, dst_img);
2223 skip |=
2224 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002225 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002226 const VkExtent3D dest_effective_extent =
2227 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002228 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002229 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002230 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002231 return skip;
2232}
2233
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002235bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002236 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237 bool skip = false;
2238
2239 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002240 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002241
2242 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002243 const VkExtent3D src_copy_extent = region.extent;
2244 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002245 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2246
Dave Houlton6f9059e2017-05-02 17:15:13 -06002247 bool slice_override = false;
2248 uint32_t depth_slices = 0;
2249
2250 // Special case for copying between a 1D/2D array and a 3D image
2251 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2252 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002253 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002254 slice_override = (depth_slices != 1);
2255 } 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 -07002256 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002257 slice_override = (depth_slices != 1);
2258 }
2259
2260 // Do all checks on source image
2261 //
2262 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002263 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2264 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 -06002265 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002266 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002267 "be 0 and 1, respectively.",
2268 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002269 }
2270 }
2271
Dave Houlton533be9f2018-03-26 17:08:30 -06002272 // VUID-VkImageCopy-srcImage-01785
2273 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2274 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 -06002275 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002276 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002277 "these must be 0 and 1, respectively.",
2278 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 }
2280
Dave Houlton533be9f2018-03-26 17:08:30 -06002281 // VUID-VkImageCopy-srcImage-01787
2282 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2283 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 -06002284 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002285 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2286 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002287 }
2288
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002289 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002290 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002291 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292 skip |=
2293 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002294 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002296 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2297 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002298 }
2299 }
2300 } else { // Pre maint 1
2301 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002302 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002303 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 -06002304 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002305 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2306 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002307 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2308 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 }
2310 }
2311 }
2312
Dave Houltonc991cc92018-03-06 11:08:51 -07002313 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002314 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002315 if (FormatIsCompressed(src_state->createInfo.format) ||
2316 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002317 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002319 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2320 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2321 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002322 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002323 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 -07002324 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002325 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002326 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002327 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002328 }
2329
Dave Houlton94a00372017-12-14 15:08:47 -07002330 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002331 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2332 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002333 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 skip |=
2335 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002336 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002337 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002338 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002339 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002340 }
2341
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002342 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002343 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2344 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002345 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002346 skip |=
2347 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002348 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002349 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002350 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002351 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002352 }
2353
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002354 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002355 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2356 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002357 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002358 skip |=
2359 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002360 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002361 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002362 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002363 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002364 }
2365 } // Compressed
2366
2367 // Do all checks on dest image
2368 //
2369 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002370 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002371 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 -06002372 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002373 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002374 "these must be 0 and 1, respectively.",
2375 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002376 }
2377 }
2378
Dave Houlton533be9f2018-03-26 17:08:30 -06002379 // VUID-VkImageCopy-dstImage-01786
2380 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2381 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 -06002382 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002383 "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 -06002384 "and 1, respectively.",
2385 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002386 }
2387
2388 // VUID-VkImageCopy-dstImage-01788
2389 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2390 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 -06002391 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002392 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2393 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002394 }
2395
2396 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002397 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002398 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 -06002399 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002400 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002401 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2402 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 }
2404 }
2405 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002406 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002407 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002408 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409 skip |=
2410 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002411 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002412 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002413 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2414 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002415 }
2416 }
2417 } else { // Pre maint 1
2418 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002419 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002420 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 -06002421 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002422 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2423 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002424 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2425 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002426 }
2427 }
2428 }
2429
Dave Houltonc991cc92018-03-06 11:08:51 -07002430 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2431 if (FormatIsCompressed(dst_state->createInfo.format) ||
2432 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002433 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002434
2435 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002436 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2437 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2438 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002439 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002440 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 -07002441 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002443 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002444 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002445 }
2446
Dave Houlton94a00372017-12-14 15:08:47 -07002447 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002448 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2449 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002450 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002451 skip |=
2452 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002453 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002454 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002455 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002456 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002457 }
2458
Dave Houltonee281a52017-12-08 13:51:02 -07002459 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2460 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2461 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002462 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002463 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 -07002464 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002465 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2466 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002467 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002468 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 }
2470
Dave Houltonee281a52017-12-08 13:51:02 -07002471 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2472 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2473 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002474 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002475 skip |=
2476 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002477 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002478 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002479 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002480 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 }
2482 } // Compressed
2483 }
2484 return skip;
2485}
2486
Dave Houltonc991cc92018-03-06 11:08:51 -07002487// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002488bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002489 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002490 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002491
2492 // Neither image is multiplane
2493 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2494 // If neither image is multi-plane the aspectMask member of src and dst must match
2495 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2496 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002497 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002498 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2499 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 -06002500 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002501 }
2502 } else {
2503 // Source image multiplane checks
2504 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2505 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2506 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2507 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002508 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002509 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 -06002510 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002511 }
2512 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2513 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2514 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002515 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002516 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 -06002517 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002518 }
2519 // Single-plane to multi-plane
2520 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2521 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2522 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002523 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002524 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 -06002525 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002526 }
2527
2528 // Dest image multiplane checks
2529 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2530 aspect = region.dstSubresource.aspectMask;
2531 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2532 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002533 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002534 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 -06002535 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002536 }
2537 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2538 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2539 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002540 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002541 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 -06002542 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002543 }
2544 // Multi-plane to single-plane
2545 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2546 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2547 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002548 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002549 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 -06002550 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002551 }
2552 }
2553
2554 return skip;
2555}
2556
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002557bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2558 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2559 const VkImageCopy *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002560 const auto *cb_node = GetCBState(commandBuffer);
2561 const auto *src_image_state = GetImageState(srcImage);
2562 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002563 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002564
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002565 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002566
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002567 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2568
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002569 for (uint32_t i = 0; i < regionCount; i++) {
2570 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002571
2572 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2573 VkExtent3D src_copy_extent = region.extent;
2574 VkExtent3D dst_copy_extent =
2575 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2576
Dave Houlton6f9059e2017-05-02 17:15:13 -06002577 bool slice_override = false;
2578 uint32_t depth_slices = 0;
2579
2580 // Special case for copying between a 1D/2D array and a 3D image
2581 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2582 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2583 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002584 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002585 slice_override = (depth_slices != 1);
2586 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2587 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002588 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002589 slice_override = (depth_slices != 1);
2590 }
2591
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002592 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2593 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2594 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002595 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002596 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002597 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002598 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002599 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2600 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002601 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002602 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2603 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002604
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002605 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002606 // No chance of mismatch if we're overriding depth slice count
2607 if (!slice_override) {
2608 // The number of depth slices in srcSubresource and dstSubresource must match
2609 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2610 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002611 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2612 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002613 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002614 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2615 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002616 if (src_slices != dst_slices) {
2617 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002618 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002619 << "] do not match";
2620 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 -06002621 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002622 }
2623 }
2624 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002625 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002626 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002627 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002628 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002629 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002630 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 -06002631 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002632 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002633 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002634
Dave Houltonc991cc92018-03-06 11:08:51 -07002635 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002636 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002637 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002638 }
2639
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002640 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002641 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2642 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002643 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002644 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 -06002645 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002646 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002648
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002649 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002650 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002651 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002652 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002653 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2654 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 -06002655 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002656 }
2657
2658 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002659 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002660 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002661 ss << "vkCmdCopyImage(): pRegion[" << i
2662 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002663 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 -06002664 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002665 }
2666
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002667 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2668 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2669 // 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 -07002670 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2671 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002672 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002673 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002674 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2675 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2676 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002677 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 -06002678 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002679 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002680
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002681 // 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 -07002682 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2683 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002684 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002685 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002686 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2687 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2688 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002689 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 -06002690 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002691 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002692 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002693
Dave Houltonfc1a4052017-04-27 14:32:45 -06002694 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002695 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2696 if (slice_override) src_copy_extent.depth = depth_slices;
2697 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002698 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002699 skip |=
2700 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2701 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2702 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2703 "width [%1d].",
2704 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002705 }
2706
2707 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002708 skip |=
2709 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2710 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2711 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2712 "height [%1d].",
2713 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002714 }
2715 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002716 skip |=
2717 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2718 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2719 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2720 "depth [%1d].",
2721 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002722 }
2723
Dave Houltonee281a52017-12-08 13:51:02 -07002724 // Adjust dest extent if necessary
2725 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2726 if (slice_override) dst_copy_extent.depth = depth_slices;
2727
2728 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002729 if (extent_check & x_bit) {
2730 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 -06002731 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002732 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002733 "width [%1d].",
2734 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002735 }
2736 if (extent_check & y_bit) {
2737 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 -06002738 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002739 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002740 "height [%1d].",
2741 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002742 }
2743 if (extent_check & z_bit) {
2744 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 -06002745 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002746 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002747 "depth [%1d].",
2748 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002749 }
2750
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002751 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2752 // must not overlap in memory
2753 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002754 for (uint32_t j = 0; j < regionCount; j++) {
2755 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002756 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002757 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002758 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002759 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 -06002760 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002761 }
2762 }
2763 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002764 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002765
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002766 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2767 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2768 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002769 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002770 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2771 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002772 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 -06002773 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002774 }
2775 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002776 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002777 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2778 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 -06002779 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002780 }
2781 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002782
Dave Houlton33c22b72017-02-28 13:16:02 -07002783 // Source and dest image sample counts must match
2784 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2785 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2786 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 -06002787 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002788 }
2789
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002790 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2791 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002792 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002793 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2794 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2795 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2796 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002797 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002798 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2799 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2800 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2801 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002802 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002803 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002804 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002805 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2806 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002807 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002808 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2809 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2810 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2811 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2812 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2813 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002814 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002815 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002816 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2817 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002818 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002819 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2820 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002821 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2822 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002823 }
2824
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002825 return skip;
2826}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002827
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002828void ValidationStateTracker::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
2829 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
2830 uint32_t regionCount, const VkImageCopy *pRegions) {
2831 auto cb_node = GetCBState(commandBuffer);
2832 auto src_image_state = GetImageState(srcImage);
2833 auto dst_image_state = GetImageState(dstImage);
2834
2835 // Update bindings between images and cmd buffer
2836 AddCommandBufferBindingImage(cb_node, src_image_state);
2837 AddCommandBufferBindingImage(cb_node, dst_image_state);
2838}
2839
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002840void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2841 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2842 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002843 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2844 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002845 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002846 auto src_image_state = GetImageState(srcImage);
2847 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002848
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002849 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002850 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002851 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2852 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002853 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002854}
2855
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002856// Returns true if sub_rect is entirely contained within rect
2857static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2858 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2859 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2860 return false;
2861 return true;
2862}
2863
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002864bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002865 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2866 const VkRect2D &render_area, uint32_t rect_count,
2867 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002868 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002869 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2870 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002871 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002872 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002873
2874 for (uint32_t j = 0; j < rect_count; j++) {
2875 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002876 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 -07002877 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2878 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2879 "the current render pass instance.",
2880 j);
2881 }
2882
2883 if (image_view_state) {
2884 // The layers specified by a given element of pRects must be contained within every attachment that
2885 // pAttachments refers to
2886 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2887 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2888 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002889 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2890 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2891 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2892 "of pAttachment[%d].",
2893 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002894 }
2895 }
2896 }
2897 return skip;
2898}
2899
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002900bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2901 const VkClearAttachment *pAttachments, uint32_t rectCount,
2902 const VkClearRect *pRects) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002903 bool skip = false;
John Zulauf441558b2019-08-12 11:47:39 -06002904 const CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
Petr Kraus2dffb382019-08-10 02:52:12 +02002905 if (!cb_node) return skip;
2906
2907 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2908 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2909 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
2910 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
2911 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
2912 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2913 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
2914 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2915 // CmdClearAttachments.
2916 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 -07002917 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
locke-lunarg9edc2812019-06-17 23:18:52 -06002918 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
Lockee9aeebf2019-03-03 23:50:08 -07002919 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2920 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002921 }
Petr Kraus2dffb382019-08-10 02:52:12 +02002922 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002923
2924 // Validate that attachment is in reference list of active subpass
2925 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002926 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002927 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002928 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002929 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002930 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002931
John Zulauf3a548ef2019-02-01 16:14:07 -07002932 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2933 auto clear_desc = &pAttachments[attachment_index];
2934 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002935
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002936 if (0 == clear_desc->aspectMask) {
2937 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002938 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002939 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2940 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 -06002941 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002942 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002943 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2944 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2945 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2946 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002947 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2948 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2949 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2950 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2951 attachment_index, clear_desc->colorAttachment,
2952 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2953 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2954 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002955
John Zulauff2582972019-02-09 14:53:30 -07002956 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2957 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002958 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2960 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002961 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002962 " subpass %u. colorAttachmentCount=%u",
2963 attachment_index, clear_desc->colorAttachment,
2964 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2965 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002966 }
John Zulauff2582972019-02-09 14:53:30 -07002967 fb_attachment = color_attachment;
2968
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002969 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2970 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2971 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002972 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002973 skip |=
2974 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2975 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002976 }
2977 } else { // Must be depth and/or stencil
2978 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2979 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002980 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002981 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 -07002982 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2983 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002984 }
2985 if (!subpass_desc->pDepthStencilAttachment ||
2986 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2987 skip |= log_msg(
2988 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002989 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002990 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002991 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002992 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002993 }
2994 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002995 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002996 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2997 rectCount, pRects);
John Zulauf441558b2019-08-12 11:47:39 -06002998 }
2999 }
3000 }
3001 return skip;
3002}
3003
3004void CoreChecks::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
3005 const VkClearAttachment *pAttachments, uint32_t rectCount,
3006 const VkClearRect *pRects) {
3007 auto *cb_node = GetCBState(commandBuffer);
3008 if (cb_node->activeRenderPass && (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY)) {
3009 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
3010 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
3011 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
3012 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
3013 const auto clear_desc = &pAttachments[attachment_index];
3014 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3015 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3016 (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount)) {
3017 fb_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
3018 } else if ((clear_desc->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) &&
3019 subpass_desc->pDepthStencilAttachment) {
3020 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
3021 }
3022 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003023 if (!clear_rect_copy) {
3024 // We need a copy of the clear rectangles that will persist until the last lambda executes
3025 // but we want to create it as lazily as possible
3026 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003027 }
John Zulauf441558b2019-08-12 11:47:39 -06003028 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
3029 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003030 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauff1640d12019-08-13 15:39:58 -06003031 const CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07003032 assert(rectCount == clear_rect_copy->size());
John Zulauf441558b2019-08-12 11:47:39 -06003033 const FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07003034 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
3035 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07003036 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
3037 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07003038 return skip;
3039 };
3040 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07003041 }
3042 }
3043 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003044}
3045
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003046bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3047 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3048 const VkImageResolve *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003049 const auto *cb_node = GetCBState(commandBuffer);
3050 const auto *src_image_state = GetImageState(srcImage);
3051 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003052
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003053 bool skip = false;
3054 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003055 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
3056 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003057 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003058 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003059 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
3060 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003061 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
3062 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003063
Cort Stratton7df30962018-05-17 19:45:57 -07003064 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003065 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003066 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003067 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
3068 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
3069 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003070 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003071 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
3072 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003073 // For each region, the number of layers in the image subresource should not be zero
3074 // For each region, src and dest image aspect must be color only
3075 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003076 skip |=
3077 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
3078 skip |=
3079 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003080 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003081 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
3082 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003083 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003084 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
3085 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003086 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
3087 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
3088 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
3089 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
3090 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003091 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3092 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003093 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003094 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
3095 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07003096
3097 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003098 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
3099 skip |= log_msg(
3100 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003101 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003102 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003103 }
Cort Stratton7df30962018-05-17 19:45:57 -07003104 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003105 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
3106 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
3107 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00003108 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003109 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 -06003110 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003111 }
3112 }
3113
3114 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
3115 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003116 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 -06003117 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003118 }
3119 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
3120 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003121 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 -06003122 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003123 }
3124 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3125 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3126 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 -06003127 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003128 }
3129 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3130 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3131 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 -06003132 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003133 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003134 } else {
3135 assert(0);
3136 }
3137 return skip;
3138}
3139
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003140void ValidationStateTracker::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3141 VkImageLayout srcImageLayout, VkImage dstImage,
3142 VkImageLayout dstImageLayout, uint32_t regionCount,
3143 const VkImageResolve *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003144 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003145 auto src_image_state = GetImageState(srcImage);
3146 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003147
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003148 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003149 AddCommandBufferBindingImage(cb_node, src_image_state);
3150 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003151}
3152
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003153bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3154 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3155 const VkImageBlit *pRegions, VkFilter filter) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003156 const auto *cb_node = GetCBState(commandBuffer);
3157 const auto *src_image_state = GetImageState(srcImage);
3158 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003159
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003160 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003161 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003162 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003163 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003164 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003165 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003166 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003167 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003168 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003169 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3170 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003171 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003172 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3173 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003174 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003175 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3176 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003177 skip |=
3178 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003179 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3180 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003181 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003182 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003183 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003184 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003185
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003186 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003187
Dave Houlton33c2d252017-06-09 17:08:32 -06003188 VkFormat src_format = src_image_state->createInfo.format;
3189 VkFormat dst_format = dst_image_state->createInfo.format;
3190 VkImageType src_type = src_image_state->createInfo.imageType;
3191 VkImageType dst_type = dst_image_state->createInfo.imageType;
3192
Cort Stratton186b1a22018-05-01 20:18:06 -04003193 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003194 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003195 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3196 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003197 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003198 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3199 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3200 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003201 }
3202
3203 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3204 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 -06003205 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003206 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 }
3208
Dave Houlton33c2d252017-06-09 17:08:32 -06003209 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3210 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3211 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 -06003212 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003213 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003214 }
3215
3216 // Validate consistency for unsigned formats
3217 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3218 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003219 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 << "the other one must also have unsigned integer format. "
3221 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3222 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 -06003223 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003224 }
3225
3226 // Validate consistency for signed formats
3227 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3228 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003229 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003230 << "the other one must also have signed integer format. "
3231 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3232 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 -06003233 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 }
3235
3236 // Validate filter for Depth/Stencil formats
3237 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3238 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003239 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003240 << "then filter must be VK_FILTER_NEAREST.";
3241 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 -06003242 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003243 }
3244
3245 // Validate aspect bits and formats for depth/stencil images
3246 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3247 if (src_format != dst_format) {
3248 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003249 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003250 << "stencil, the other one must have exactly the same format. "
3251 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3252 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003253 skip |=
3254 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3255 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003256 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003257 } // Depth or Stencil
3258
3259 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003260 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003261 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003262 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3263 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3264 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003265 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003266 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3267 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003268 for (uint32_t i = 0; i < regionCount; i++) {
3269 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003270 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003271 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003272 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3273 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003274 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003275 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3276 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003277 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3278 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3279 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003280 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003281 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003282 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003283 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003284 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3285 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003286 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003287 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3288 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003289 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003290 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3291 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003292 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003293 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003294 skip |=
3295 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3296 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003297 }
Dave Houlton48989f32017-05-26 15:01:46 -06003298 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3299 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003300 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003301 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003302 skip |=
3303 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3304 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003305 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003306
3307 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003308 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003309 skip |= log_msg(
3310 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3311 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3312 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003313 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003314
Dave Houlton48989f32017-05-26 15:01:46 -06003315 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003316 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 -06003317 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003318 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003319 }
Dave Houlton48989f32017-05-26 15:01:46 -06003320
Dave Houlton33c2d252017-06-09 17:08:32 -06003321 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3322 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 -06003323 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003324 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003325 "image format %s.",
3326 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003327 }
3328
3329 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3330 skip |= log_msg(
3331 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003332 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003333 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3334 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003335 }
3336
Dave Houlton48989f32017-05-26 15:01:46 -06003337 // Validate source image offsets
3338 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003339 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003340 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003341 skip |=
3342 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3343 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3344 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3345 "of (%1d, %1d). These must be (0, 1).",
3346 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003347 }
3348 }
3349
Dave Houlton33c2d252017-06-09 17:08:32 -06003350 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003351 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3352 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 -06003353 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003354 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003355 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3356 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003357 }
3358 }
3359
Dave Houlton33c2d252017-06-09 17:08:32 -06003360 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003361 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3362 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003363 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003364 skip |= log_msg(
3365 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3366 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3367 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3368 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003369 }
3370 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3371 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003372 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003373 skip |= log_msg(
3374 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003375 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003376 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003377 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003378 }
3379 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3380 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003381 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003382 skip |= log_msg(
3383 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3384 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3385 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3386 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003387 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003388 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003389 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 -06003390 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003391 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003392 }
Dave Houlton48989f32017-05-26 15:01:46 -06003393
3394 // Validate dest image offsets
3395 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003396 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003397 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003398 skip |=
3399 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3400 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3401 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3402 "(%1d, %1d). These must be (0, 1).",
3403 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003404 }
3405 }
3406
Dave Houlton33c2d252017-06-09 17:08:32 -06003407 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003408 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3409 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 -06003410 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003411 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003412 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3413 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003414 }
3415 }
3416
Dave Houlton33c2d252017-06-09 17:08:32 -06003417 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003418 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3419 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003420 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003421 skip |= log_msg(
3422 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3423 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3424 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3425 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003426 }
3427 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3428 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003429 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003430 skip |= log_msg(
3431 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003432 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003433 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003434 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003435 }
3436 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3437 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003438 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003439 skip |= log_msg(
3440 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3441 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3442 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3443 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003444 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003445 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003446 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 -06003447 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003448 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003449 }
3450
Dave Houlton33c2d252017-06-09 17:08:32 -06003451 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3452 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3453 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003454 skip |=
3455 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3456 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3457 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3458 "layerCount other than 1.",
3459 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003460 }
3461 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003462 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003463 } else {
3464 assert(0);
3465 }
3466 return skip;
3467}
3468
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003469void ValidationStateTracker::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3470 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
3471 uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3472 auto cb_node = GetCBState(commandBuffer);
3473 auto src_image_state = GetImageState(srcImage);
3474 auto dst_image_state = GetImageState(dstImage);
3475
3476 // Update bindings between images and cmd buffer
3477 AddCommandBufferBindingImage(cb_node, src_image_state);
3478 AddCommandBufferBindingImage(cb_node, dst_image_state);
3479}
3480
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003481void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3482 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3483 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003484 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3485 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003486 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003487 auto src_image_state = GetImageState(srcImage);
3488 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003489
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003490 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003491 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003492 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3493 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003494 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003495}
3496
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003497// 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 -06003498bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3499 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003500 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003501 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003502 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003503 // Iterate over the layout maps for each referenced image
3504 for (const auto &layout_map_entry : pCB->image_layout_map) {
3505 const auto image = layout_map_entry.first;
3506 const auto *image_state = GetImageState(image);
3507 if (!image_state) continue; // Can't check layouts of a dead image
unknown089cdb82019-07-11 12:58:43 -06003508 const auto &subres_map = layout_map_entry.second;
John Zulauff660ad62019-03-23 07:16:05 -06003509 ImageSubresourcePair isr_pair;
3510 isr_pair.image = image;
3511 isr_pair.hasSubresource = true;
John Zulauff660ad62019-03-23 07:16:05 -06003512 // Validate the initial_uses for each subresource referenced
3513 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3514 isr_pair.subresource = (*it_init).subresource;
3515 VkImageLayout initial_layout = (*it_init).layout;
3516 VkImageLayout image_layout;
3517 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3518 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3519 // TODO: Set memory invalid which is in mem_tracker currently
3520 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003521 // Need to look up the inital layout *state* to get a bit more information
3522 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3523 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3524 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3525 if (!matches) {
3526 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003527 skip |= log_msg(
3528 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3529 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
unknown089cdb82019-07-11 12:58:43 -06003530 "Submitted command buffer expects %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
locke-lunargadbb54c2019-06-26 00:05:17 -06003531 "to be in layout %s--instead, current layout is %s.%s",
unknown089cdb82019-07-11 12:58:43 -06003532 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
locke-lunargadbb54c2019-06-26 00:05:17 -06003533 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3534 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003535 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003536 }
3537 }
John Zulauff660ad62019-03-23 07:16:05 -06003538 }
3539
3540 // Update all layout set operations (which will be a subset of the initial_layouts
3541 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3542 VkImageLayout layout = (*it_set).layout;
3543 isr_pair.subresource = (*it_set).subresource;
3544 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003545 }
3546 }
John Zulauff660ad62019-03-23 07:16:05 -06003547
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003548 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003549}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003550
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003551void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003552 for (const auto &layout_map_entry : pCB->image_layout_map) {
3553 const auto image = layout_map_entry.first;
3554 const auto *image_state = GetImageState(image);
3555 if (!image_state) continue; // Can't set layouts of a dead image
3556 const auto &subres_map = layout_map_entry.second;
3557 ImageSubresourcePair isr_pair;
3558 isr_pair.image = image;
3559 isr_pair.hasSubresource = true;
3560
3561 // Update all layout set operations (which will be a subset of the initial_layouts
3562 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3563 VkImageLayout layout = (*it_set).layout;
3564 isr_pair.subresource = (*it_set).subresource;
3565 SetGlobalLayout(isr_pair, layout);
3566 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003567 }
3568}
3569
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003570// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003571// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3572// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003573bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3574 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003575 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003576 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003577 const char *vuid;
3578 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3579
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003580 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3581 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003582 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3583 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3584 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003585 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003586 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3587 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3588 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3589 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3590 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3591 skip |=
3592 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3593 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003594 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003595 }
3596 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003597 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3598 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003599 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003600 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003601 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 -06003602 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003603 }
3604 }
3605
3606 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3607 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003608 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003609 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003610 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 -06003611 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003612 }
3613 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003614 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003615}
3616
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003617bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
John Zulauf9d2b6382019-07-25 15:21:36 -06003618 const VkRenderPassCreateInfo2KHR *pCreateInfo) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003619 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003620 const char *vuid;
3621 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3622 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003623
Jason Ekstranda1906302017-12-03 20:16:32 -08003624 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3625 VkFormat format = pCreateInfo->pAttachments[i].format;
3626 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3627 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3628 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003629 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 -06003630 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003631 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3632 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3633 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3634 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003635 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003636 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003637 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 -06003638 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003639 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3640 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3641 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3642 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003643 }
3644 }
3645 }
3646
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003647 // Track when we're observing the first use of an attachment
3648 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3649 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003650 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003651
3652 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3653 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3654 auto attach_index = subpass.pInputAttachments[j].attachment;
3655 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003656 switch (subpass.pInputAttachments[j].layout) {
3657 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3658 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3659 // These are ideal.
3660 break;
3661
3662 case VK_IMAGE_LAYOUT_GENERAL:
3663 // May not be optimal. TODO: reconsider this warning based on other constraints.
3664 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003665 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003666 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3667 break;
3668
Tobias Hectorbbb12282018-10-22 15:17:59 +01003669 case VK_IMAGE_LAYOUT_UNDEFINED:
3670 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3671 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3672 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3673 "Layout for input attachment reference %u in subpass %u is %s but must be "
3674 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003675 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003676 break;
3677
Graeme Leese668a9862018-10-08 10:40:02 +01003678 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3679 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003680 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003681 break;
3682 } else {
3683 // Intentionally fall through to generic error message
3684 }
3685 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003686
Cort Stratton7547f772017-05-04 15:18:52 -07003687 default:
3688 // No other layouts are acceptable
3689 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 -06003690 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003691 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3692 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3693 }
3694
Cort Stratton7547f772017-05-04 15:18:52 -07003695 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003696 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3697 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003698
3699 bool used_as_depth =
3700 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3701 bool used_as_color = false;
3702 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3703 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3704 }
3705 if (!used_as_depth && !used_as_color &&
3706 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003707 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3708 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3709 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3710 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003711 }
3712 }
3713 attach_first_use[attach_index] = false;
3714 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003715
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003716 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3717 auto attach_index = subpass.pColorAttachments[j].attachment;
3718 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3719
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003720 // TODO: Need a way to validate shared presentable images here, currently just allowing
3721 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3722 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003723 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003724 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003725 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003726 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3727 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003728 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003729
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003730 case VK_IMAGE_LAYOUT_GENERAL:
3731 // May not be optimal; TODO: reconsider this warning based on other constraints?
3732 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003733 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003734 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3735 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003736
Tobias Hectorbbb12282018-10-22 15:17:59 +01003737 case VK_IMAGE_LAYOUT_UNDEFINED:
3738 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3739 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3740 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3741 "Layout for color attachment reference %u in subpass %u is %s but should be "
3742 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3743 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3744 break;
3745
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003746 default:
3747 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 -06003748 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003749 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3750 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003751 }
3752
John Zulauf4eee2692019-02-09 16:14:25 -07003753 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3754 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3755 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003756 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3757 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 -07003758 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003759 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003760 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003761 }
3762
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003763 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003764 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3765 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003766 }
3767 attach_first_use[attach_index] = false;
3768 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003769
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003770 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3771 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003772 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3773 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3774 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003775 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003776
Dave Houltona9df0ce2018-02-07 10:51:23 -07003777 case VK_IMAGE_LAYOUT_GENERAL:
3778 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3779 // doing a bunch of transitions.
3780 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003781 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003782 "GENERAL layout for depth attachment may not give optimal performance.");
3783 break;
3784
Tobias Hectorbbb12282018-10-22 15:17:59 +01003785 case VK_IMAGE_LAYOUT_UNDEFINED:
3786 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3787 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3788 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3789 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3790 "layout or GENERAL.",
3791 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3792 break;
3793
Dave Houltona9df0ce2018-02-07 10:51:23 -07003794 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3795 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003796 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003797 break;
3798 } else {
3799 // Intentionally fall through to generic error message
3800 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003801 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003802
Dave Houltona9df0ce2018-02-07 10:51:23 -07003803 default:
3804 // No other layouts are acceptable
3805 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 -06003806 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003807 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3808 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3809 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003810 }
3811
3812 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3813 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003814 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3815 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003816 }
3817 attach_first_use[attach_index] = false;
3818 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003819 }
3820 return skip;
3821}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003822
Mark Lobodzinski96210742017-02-09 10:33:46 -07003823// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3824// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06003825bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003826 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003827 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003828 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003829 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003830 if (strict) {
3831 correct_usage = ((actual & desired) == desired);
3832 } else {
3833 correct_usage = ((actual & desired) != 0);
3834 }
3835 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003836 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003837 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06003838 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
3839 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06003840 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3841 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003842 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06003843 skip =
3844 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 -06003845 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3846 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003847 }
3848 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003849 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003850}
3851
3852// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3853// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003854bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003855 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003856 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
3857 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003858}
3859
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003860bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003861 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003862 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003863 bool skip = false;
3864 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3865 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003866 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3867 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003868 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07003869 format_properties.linearTilingFeatures, image_state->createInfo.format,
3870 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003871 }
3872 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3873 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3874 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3875 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003876 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003877 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003878 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003879 }
3880 }
3881 return skip;
3882}
3883
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003884bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003885 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003886 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003887 // layerCount must not be zero
3888 if (subresource_layers->layerCount == 0) {
3889 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3890 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3891 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3892 }
3893 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3894 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3895 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3896 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3897 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3898 }
3899 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3900 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3901 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3902 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3903 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3904 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3905 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3906 func_name, i, member);
3907 }
3908 return skip;
3909}
3910
Mark Lobodzinski96210742017-02-09 10:33:46 -07003911// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3912// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003913bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06003914 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003915 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
3916 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003917}
3918
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003919bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3920 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003921 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003922
3923 const VkDeviceSize &range = pCreateInfo->range;
3924 if (range != VK_WHOLE_SIZE) {
3925 // Range must be greater than 0
3926 if (range <= 0) {
3927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3928 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3929 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3930 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3931 range);
3932 }
3933 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02003934 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
3935 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3937 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3938 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3939 ") 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 +02003940 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003941 range, format_size);
3942 }
3943 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02003944 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
3945 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3946 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3947 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3948 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
3949 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3950 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003951 }
3952 // The sum of range and offset must be less than or equal to the size of buffer
3953 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3954 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3955 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3956 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3957 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3958 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3959 range, pCreateInfo->offset, buffer_state->createInfo.size);
3960 }
3961 }
3962 return skip;
3963}
3964
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003965bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003966 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003967 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003968 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3969 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3970 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3971 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3972 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3973 "be supported for uniform texel buffers");
3974 }
3975 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3976 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3977 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3978 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3979 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3980 "be supported for storage texel buffers");
3981 }
3982 return skip;
3983}
3984
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003985bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3986 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003987 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003988
Dave Houltond8ed0212018-05-16 17:18:24 -06003989 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003990
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003991 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003992 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 -06003993 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003994 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003995 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003996 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003997
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003998 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003999 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 -06004000 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004001 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004002 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06004003 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004004
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004005 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004006 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 -06004007 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004008 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004009 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06004010 }
Jeff Bolz87697532019-01-11 22:54:00 -06004011
4012 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
4013 if (chained_devaddr_struct) {
4014 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
4015 chained_devaddr_struct->deviceAddress != 0) {
4016 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4017 "VUID-VkBufferCreateInfo-deviceAddress-02604",
4018 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
4019 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
4020 }
4021 }
4022
4023 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004024 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06004025 skip |= log_msg(
4026 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4027 "VUID-VkBufferCreateInfo-flags-02605",
4028 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
4029 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
4030 }
4031
4032 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06004033 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06004034 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
4035 "VUID-VkBufferCreateInfo-usage-02606",
4036 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
4037 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
4038 }
4039
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004040 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004041 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
4042 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
4043 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07004044 }
4045
Mark Lobodzinski96210742017-02-09 10:33:46 -07004046 return skip;
4047}
4048
John Zulauf7eeb6f72019-06-17 11:56:36 -06004049void ValidationStateTracker::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
4050 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer,
4051 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004052 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004053 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
John Zulauf4db45df2019-07-23 06:10:40 -06004054 std::unique_ptr<BUFFER_STATE> buffer_state(new BUFFER_STATE(*pBuffer, pCreateInfo));
4055
4056 // Get a set of requirements in the case the app does not
4057 DispatchGetBufferMemoryRequirements(device, *pBuffer, &buffer_state->requirements);
4058
4059 bufferMap.insert(std::make_pair(*pBuffer, std::move(buffer_state)));
Mark Lobodzinski96210742017-02-09 10:33:46 -07004060}
4061
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004062bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
4063 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004064 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004065 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004066 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
4067 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004068 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07004069 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
4070 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004071 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06004072 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
4073 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
4074 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06004075
Shannon McPherson0eb84f62018-06-18 16:32:40 -06004076 // Buffer view offset must be less than the size of buffer
4077 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
4078 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4079 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
4080 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4081 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
4082 pCreateInfo->offset, buffer_state->createInfo.size);
4083 }
4084
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06004085 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05004086 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
4087 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
4088 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4089 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4090 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
4091 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4092 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
4093 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
4094 }
4095
4096 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
4097 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
4098 if ((elementSize % 3) == 0) {
4099 elementSize /= 3;
4100 }
4101 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
4102 VkDeviceSize alignmentRequirement =
4103 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
4104 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
4105 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4106 }
4107 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4108 skip |= log_msg(
4109 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4110 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
4111 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
4112 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4113 ") must be a multiple of the lesser of "
4114 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4115 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
4116 "(%" PRId32
4117 ") is VK_TRUE, the size of a texel of the requested format. "
4118 "If the size of a texel is a multiple of three bytes, then the size of a "
4119 "single component of format is used instead",
4120 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4121 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4122 }
4123 }
4124 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4125 VkDeviceSize alignmentRequirement =
4126 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4127 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4128 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4129 }
4130 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4131 skip |= log_msg(
4132 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4133 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4134 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4135 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4136 ") must be a multiple of the lesser of "
4137 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4138 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4139 "(%" PRId32
4140 ") is VK_TRUE, the size of a texel of the requested format. "
4141 "If the size of a texel is a multiple of three bytes, then the size of a "
4142 "single component of format is used instead",
4143 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4144 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4145 }
4146 }
4147 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004148
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004149 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004150
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004151 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004152 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004153 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004154}
4155
John Zulauf7eeb6f72019-06-17 11:56:36 -06004156void ValidationStateTracker::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
4157 const VkAllocationCallbacks *pAllocator, VkBufferView *pView,
4158 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004159 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004160 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07004161}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004162
4163// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004164bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004165 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004166 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004167 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4168 if (image != VK_NULL_HANDLE) {
4169 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4170 }
4171
Dave Houlton1d2022c2017-03-29 11:43:58 -06004172 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004173 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004174 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004175 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004176 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004177 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004178 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004179 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004180 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004181 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004182 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004183 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004184 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4185 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004186 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004187 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004188 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004189 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4190 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004191 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004192 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004193 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004194 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004195 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004196 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004198 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004199 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004200 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004201 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004202 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004203 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004204 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004205 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004206 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004207 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004208 } else if (FormatIsMultiplane(format)) {
4209 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4210 if (3 == FormatPlaneCount(format)) {
4211 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4212 }
4213 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004214 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004215 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4216 "set, where n = [0, 1, 2].",
4217 func_name);
4218 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004219 }
4220 return skip;
4221}
4222
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004223bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4224 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4225 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004226 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004227 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004228
4229 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004230 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004231 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 -06004232 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004233 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004234 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4235 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004236 }
Petr Kraus4d718682017-05-18 03:38:41 +02004237
Petr Krausffa94af2017-08-08 21:46:02 +02004238 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4239 if (subresourceRange.levelCount == 0) {
4240 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 -06004241 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004242 } else {
4243 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004244
Petr Krausffa94af2017-08-08 21:46:02 +02004245 if (necessary_mip_count > image_mip_count) {
4246 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 -06004247 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004248 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004249 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004250 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004251 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004252 }
Petr Kraus4d718682017-05-18 03:38:41 +02004253 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004254 }
Petr Kraus4d718682017-05-18 03:38:41 +02004255
4256 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004257 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004258 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 -06004259 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004260 "%s: %s.baseArrayLayer (= %" PRIu32
4261 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4262 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004263 }
Petr Kraus4d718682017-05-18 03:38:41 +02004264
Petr Krausffa94af2017-08-08 21:46:02 +02004265 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4266 if (subresourceRange.layerCount == 0) {
4267 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 -06004268 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004269 } else {
4270 const uint64_t necessary_layer_count =
4271 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004272
Petr Krausffa94af2017-08-08 21:46:02 +02004273 if (necessary_layer_count > image_layer_count) {
4274 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 -06004275 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004276 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004277 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004278 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004279 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004280 }
Petr Kraus4d718682017-05-18 03:38:41 +02004281 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004282 }
Petr Kraus4d718682017-05-18 03:38:41 +02004283
Mark Lobodzinski602de982017-02-09 11:01:33 -07004284 return skip;
4285}
4286
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004287bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004288 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004289 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004290 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4291 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4292 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4293
4294 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4295 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4296
4297 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004298 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4299 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004300 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004301 : "VUID-VkImageViewCreateInfo-image-01482")
4302 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4303 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004304 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004305 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4306 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004307
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004308 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004309 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4310 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4311}
4312
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004313bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004314 const VkImageSubresourceRange &subresourceRange,
4315 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004316 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004317 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4318 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4319 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4320 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004321
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004322 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4323 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4324 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004325}
4326
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004327bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004328 const VkImageSubresourceRange &subresourceRange,
4329 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004330 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004331 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4332 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4333 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4334 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004335
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004336 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4337 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004338 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4339}
4340
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004341bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004342 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
John Zulaufa4472282019-08-22 14:44:34 -06004343 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004344 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004345 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4346 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4347 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4348 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004349
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004350 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4351 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004352 subresourceRangeErrorCodes);
4353}
4354
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004355bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4356 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004357 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004358 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004359 if (image_state) {
ByumjinConffx1c74abf2019-08-14 15:16:40 -07004360 skip |=
4361 ValidateImageUsageFlags(image_state,
4362 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
4363 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4364 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV | VK_IMAGE_USAGE_FRAGMENT_DENSITY_MAP_BIT_EXT,
4365 false, kVUIDUndefined, "vkCreateImageView()",
4366 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|"
4367 "SHADING_RATE_IMAGE|FRAGMENT_DENSITY_MAP]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004368 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004369 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004370 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004371 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004372 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004373 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004374
4375 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4376 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004377 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4378 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004379 VkFormat view_format = pCreateInfo->format;
4380 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004381 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004382 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004383
Dave Houltonbd2e2622018-04-10 16:41:14 -06004384 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004385 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004386 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004387 image_usage = chained_ivuci_struct->usage;
4388 }
4389
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004390 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4391 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004392 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004393 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004394 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004395 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004396 std::stringstream ss;
4397 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004398 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004399 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004400 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 -07004401 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004402 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004403 }
4404 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004405 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004406 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4407 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4408 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4409 std::stringstream ss;
4410 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004411 << " is not in the same format compatibility class as "
4412 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004413 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4414 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004415 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-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004417 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004418 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004419 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004420 }
4421 } else {
4422 // Format MUST be IDENTICAL to the format the image was created with
4423 if (image_format != view_format) {
4424 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004425 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004426 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004427 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004428 skip |=
4429 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004430 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004431 }
4432 }
4433
4434 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004435 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004436
4437 switch (image_type) {
4438 case VK_IMAGE_TYPE_1D:
4439 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004440 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 -07004441 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004442 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4443 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004444 }
4445 break;
4446 case VK_IMAGE_TYPE_2D:
4447 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4448 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4449 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004450 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 -07004451 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004452 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4453 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004454 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004455 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 -07004456 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004457 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4458 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004459 }
4460 }
4461 break;
4462 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004463 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004464 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4465 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4466 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004467 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004468 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004469 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004470 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4471 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004472 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4473 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004474 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004475 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004476 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004477 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4478 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004479 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4480 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004481 }
4482 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004483 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 -07004484 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004485 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4486 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004487 }
4488 }
4489 } else {
4490 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004491 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 -07004492 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004493 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4494 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004495 }
4496 }
4497 break;
4498 default:
4499 break;
4500 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004501
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004502 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004503 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004504 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004505 }
4506
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004507 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004508 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4509 : format_properties.optimalTilingFeatures;
4510
4511 if (tiling_features == 0) {
4512 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 -07004513 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004514 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4515 "physical device.",
4516 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4517 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4518 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 -07004519 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004520 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4521 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4522 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4523 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4524 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 -07004525 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004526 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4527 "VK_IMAGE_USAGE_STORAGE_BIT.",
4528 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4529 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4530 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4531 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 -07004532 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004533 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4534 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4535 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4536 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4537 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4538 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 -07004539 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004540 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4541 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4542 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004543 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004544
Jeff Bolz9af91c52018-09-01 21:53:57 -05004545 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4546 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4547 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 -07004548 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004549 "vkCreateImageView() If image was created with usage containing "
4550 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4551 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4552 }
4553 if (view_format != VK_FORMAT_R8_UINT) {
4554 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 -07004555 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004556 "vkCreateImageView() If image was created with usage containing "
4557 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4558 }
4559 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004560 }
4561 return skip;
4562}
4563
John Zulauf7eeb6f72019-06-17 11:56:36 -06004564void ValidationStateTracker::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4565 const VkAllocationCallbacks *pAllocator, VkImageView *pView,
4566 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004567 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004568 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004569 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004570}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004571
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004572static inline bool ValidateCmdCopyBufferBounds(const debug_report_data *report_data, const BUFFER_STATE *src_buffer_state,
4573 const BUFFER_STATE *dst_buffer_state, uint32_t regionCount,
4574 const VkBufferCopy *pRegions) {
4575 bool skip = false;
4576
4577 VkDeviceSize src_buffer_size = src_buffer_state->createInfo.size;
4578 VkDeviceSize dst_buffer_size = dst_buffer_state->createInfo.size;
4579 VkDeviceSize src_min = UINT64_MAX;
4580 VkDeviceSize src_max = 0;
4581 VkDeviceSize dst_min = UINT64_MAX;
4582 VkDeviceSize dst_max = 0;
4583
4584 for (uint32_t i = 0; i < regionCount; i++) {
4585 src_min = std::min(src_min, pRegions[i].srcOffset);
4586 src_max = std::max(src_max, (pRegions[i].srcOffset + pRegions[i].size));
4587 dst_min = std::min(dst_min, pRegions[i].dstOffset);
4588 dst_max = std::max(dst_max, (pRegions[i].dstOffset + pRegions[i].size));
4589
4590 // The srcOffset member of each element of pRegions must be less than the size of srcBuffer
4591 if (pRegions[i].srcOffset >= src_buffer_size) {
4592 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4593 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-srcOffset-00113",
4594 "vkCmdCopyBuffer(): pRegions[%d].srcOffset (%" PRIuLEAST64
4595 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4596 i, pRegions[i].srcOffset, i, pRegions[i].size);
4597 }
4598
4599 // The dstOffset member of each element of pRegions must be less than the size of dstBuffer
4600 if (pRegions[i].dstOffset >= dst_buffer_size) {
4601 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4602 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-dstOffset-00114",
4603 "vkCmdCopyBuffer(): pRegions[%d].dstOffset (%" PRIuLEAST64
4604 ") is greater than pRegions[%d].size (%" PRIuLEAST64 ").",
4605 i, pRegions[i].dstOffset, i, pRegions[i].size);
4606 }
4607
4608 // The size member of each element of pRegions must be less than or equal to the size of srcBuffer minus srcOffset
4609 if (pRegions[i].size > (src_buffer_size - pRegions[i].srcOffset)) {
4610 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4611 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00115",
4612 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4613 ") is greater than the source buffer size (%" PRIuLEAST64
4614 ") minus pRegions[%d].srcOffset (%" PRIuLEAST64 ").",
4615 i, pRegions[i].size, src_buffer_size, i, pRegions[i].srcOffset);
4616 }
4617
4618 // The size member of each element of pRegions must be less than or equal to the size of dstBuffer minus dstOffset
4619 if (pRegions[i].size > (dst_buffer_size - pRegions[i].dstOffset)) {
4620 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4621 HandleToUint64(dst_buffer_state->buffer), "VUID-vkCmdCopyBuffer-size-00116",
4622 "vkCmdCopyBuffer(): pRegions[%d].size (%" PRIuLEAST64
4623 ") is greater than the destination buffer size (%" PRIuLEAST64
4624 ") minus pRegions[%d].dstOffset (%" PRIuLEAST64 ").",
4625 i, pRegions[i].size, dst_buffer_size, i, pRegions[i].dstOffset);
4626 }
4627 }
4628
4629 // The union of the source regions, and the union of the destination regions, must not overlap in memory
4630 if (src_buffer_state->buffer == dst_buffer_state->buffer) {
4631 if (((src_min > dst_min) && (src_min < dst_max)) || ((src_max > dst_min) && (src_max < dst_max))) {
4632 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4633 HandleToUint64(src_buffer_state->buffer), "VUID-vkCmdCopyBuffer-pRegions-00117",
4634 "vkCmdCopyBuffer(): Detected overlap between source and dest regions in memory.");
4635 }
4636 }
4637
4638 return skip;
4639}
4640
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004641bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4642 uint32_t regionCount, const VkBufferCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06004643 const auto cb_node = GetCBState(commandBuffer);
4644 const auto src_buffer_state = GetBufferState(srcBuffer);
4645 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004646
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004647 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004648 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4649 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004650 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004651 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004652 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4653 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004654 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004655 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4656 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004657 skip |=
4658 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4659 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004660 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4661 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski3438ab62019-09-02 14:19:40 -06004662 skip |= ValidateCmdCopyBufferBounds(report_data, src_buffer_state, dst_buffer_state, regionCount, pRegions);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004663 return skip;
4664}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004665
John Zulauf1686f232019-07-09 16:27:11 -06004666void ValidationStateTracker::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4667 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004668 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004669 auto src_buffer_state = GetBufferState(srcBuffer);
4670 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004671
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004672 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004673 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4674 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004675}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004676
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004677bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004678 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004679 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004680 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004681 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 -06004682 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004683 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004684 } else {
4685 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004686 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 -06004687 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004688 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004689 }
4690 }
4691 return skip;
4692}
4693
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004694bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004695 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004696 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004697
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004698 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004699 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004700 skip |=
4701 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004702 }
4703 return skip;
4704}
4705
John Zulauf7eeb6f72019-06-17 11:56:36 -06004706void ValidationStateTracker::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView,
4707 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004708 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004709 if (!image_view_state) return;
John Zulauf4fea6622019-04-01 11:38:18 -06004710 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004711
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004712 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004713 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004714 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004715}
4716
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004717bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004718 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004719
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004720 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004721 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004722 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004723 }
4724 return skip;
4725}
4726
John Zulauf7eeb6f72019-06-17 11:56:36 -06004727void ValidationStateTracker::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004728 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004729 auto buffer_state = GetBufferState(buffer);
John Zulauf4fea6622019-04-01 11:38:18 -06004730 const VulkanTypedHandle obj_struct(buffer, kVulkanObjectTypeBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004731
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004732 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004733 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06004734 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004735 if (mem_info) {
unknownf4cf0972019-08-15 16:42:02 -06004736 RemoveBufferMemoryRange(buffer, mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004737 }
4738 }
John Zulauf4fea6622019-04-01 11:38:18 -06004739 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004740 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004741}
4742
John Zulauf7eeb6f72019-06-17 11:56:36 -06004743void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4744 if (!buffer) return;
4745
4746 // Clean up validation specific data
4747 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
4748
Tony-LunarG8eb5a002019-07-25 16:49:00 -06004749 if (enabled.gpu_validation) {
4750 GpuPreCallRecordDestroyBuffer(buffer);
4751 }
4752
John Zulauf7eeb6f72019-06-17 11:56:36 -06004753 // Clean up generic buffer state
4754 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
4755}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004756bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4757 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004758 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004759 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004760 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004761 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004762 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004763 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004764 }
4765 return skip;
4766}
4767
John Zulauf7eeb6f72019-06-17 11:56:36 -06004768void ValidationStateTracker::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView,
4769 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004770 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004771 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004772 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004773
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004774 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004775 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004776 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004777}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004778
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004779bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4780 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004781 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004782 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004783 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004784 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004785 skip |=
4786 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4787 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004788 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004789 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004790 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4791 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004792 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004793 return skip;
4794}
4795
John Zulauf1686f232019-07-09 16:27:11 -06004796void ValidationStateTracker::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4797 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004798 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004799 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004800 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004801 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004802}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004803
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004804bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4805 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004806 bool skip = false;
4807
4808 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004809 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4810 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004811 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 -06004812 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004813 "%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 -06004814 "and 1, respectively.",
4815 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004816 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004817 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004818
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004819 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4820 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004821 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 -06004822 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004823 "%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 -06004824 "must be 0 and 1, respectively.",
4825 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004826 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004827 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004828
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004829 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4830 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004831 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 -06004832 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004833 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4834 "For 3D images these must be 0 and 1, respectively.",
4835 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004836 }
4837 }
4838
4839 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004840 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004841 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4842
Dave Houltona585d132019-01-18 13:05:42 -07004843 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004844 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 -06004845 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004846 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004847 " must be a multiple of this format's texel size (%" PRIu32 ").",
4848 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004849 }
4850
4851 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004852 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004853 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 -06004854 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004855 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4856 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004857 }
4858
4859 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4860 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004861 skip |=
4862 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004863 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004864 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4865 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004866 }
4867
4868 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4869 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4870 skip |= log_msg(
4871 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004872 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004873 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4874 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004875 }
4876
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004877 // Calculate adjusted image extent, accounting for multiplane image factors
4878 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4879 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4880 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4881 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
4882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4883 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
4884 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4885 "zero or <= image subresource width (%d).",
4886 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4887 adusted_image_extent.width);
4888 }
4889
4890 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4891 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4892 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
4893 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4894 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
4895 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4896 "zero or <= image subresource height (%d).",
4897 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4898 adusted_image_extent.height);
4899 }
4900
4901 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4902 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4903 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
4904 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4905 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
4906 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4907 "zero or <= image subresource depth (%d).",
4908 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4909 adusted_image_extent.depth);
4910 }
4911
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004912 // subresource aspectMask must have exactly 1 bit set
4913 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4914 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4915 if (aspect_mask_bits.count() != 1) {
4916 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 -06004917 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004918 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004919 }
4920
4921 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004922 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004923 skip |= log_msg(
4924 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004925 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004926 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4927 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004928 }
4929
4930 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004931 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004932 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004933
4934 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004935 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004936 skip |= log_msg(
4937 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004938 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004939 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4940 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004941 }
4942
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004943 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004944 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004945 skip |= log_msg(
4946 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004947 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004948 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4949 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004950 }
4951
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004952 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004953 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4954 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4955 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004956 skip |=
4957 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004958 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004959 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4960 "width & height (%d, %d)..",
4961 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004962 }
4963
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004964 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004965 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004966 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004967 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 -06004968 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004969 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004970 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004971 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004972 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004973
4974 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004975 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004976 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004977 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4978 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 -06004979 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004980 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004981 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004982 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004983 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004984 }
4985
4986 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004987 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004988 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4989 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 -06004990 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004991 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004992 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004993 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004994 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004995 }
4996
4997 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004998 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004999 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
5000 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 -06005001 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07005002 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005003 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07005004 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005005 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07005006 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005007 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005008 }
5009
5010 return skip;
5011}
5012
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005013static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005014 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005015 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005016 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005017
5018 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005019 VkExtent3D extent = pRegions[i].imageExtent;
5020 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005021
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005022 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
5023 {
Dave Houlton51653902018-06-22 17:32:13 -06005024 skip |=
5025 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5026 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
5027 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005028 }
5029
5030 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
5031
5032 // 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 -06005033 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07005034 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005035 if (image_extent.width % block_extent.width) {
5036 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
5037 }
5038 if (image_extent.height % block_extent.height) {
5039 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
5040 }
5041 if (image_extent.depth % block_extent.depth) {
5042 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
5043 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005044 }
5045
Dave Houltonfc1a4052017-04-27 14:32:45 -06005046 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005047 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 -06005048 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005049 }
5050 }
5051
5052 return skip;
5053}
5054
Chris Forbese8ba09a2017-06-01 17:39:02 -07005055static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06005056 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005057 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005058 bool skip = false;
5059
5060 VkDeviceSize buffer_size = buff_state->createInfo.size;
5061
5062 for (uint32_t i = 0; i < regionCount; i++) {
5063 VkExtent3D copy_extent = pRegions[i].imageExtent;
5064
5065 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
5066 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07005067 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
5068 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07005069
Tom Cooperb2550c72018-10-15 13:08:41 +01005070 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005071 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07005072 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005073 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
5074 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
5075
5076 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
5077 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
5078 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005079 }
5080
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005081 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
5082 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
5083 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07005084 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005085 } else {
5086 // Calculate buffer offset of final copied byte, + 1.
5087 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
5088 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
5089 max_buffer_offset *= unit_size; // convert to bytes
5090 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005091
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005092 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06005093 skip |=
5094 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
5095 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005096 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005097 }
5098 }
5099
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005100 return skip;
5101}
5102
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005103bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5104 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005105 const auto cb_node = GetCBState(commandBuffer);
5106 const auto src_image_state = GetImageState(srcImage);
5107 const auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005108
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005109 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005110
5111 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005112 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005113
5114 // Command pool must support graphics, compute, or transfer operations
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005115 const auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005116
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005117 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07005118
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005119 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5120 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 -06005121 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005122 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005123 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005124 }
Dave Houlton0ef27492018-04-04 11:41:48 -06005125 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005126 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005127 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005128 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005129
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005130 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005131 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005132 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
5133 skip |=
5134 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005135
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005136 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005137 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005138 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
5139 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005140 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005141 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
5142 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005143 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005144 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
5145 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005146 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04005147 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005148 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005149 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005150 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5151 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
5152 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005153 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005154 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07005155 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005156 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005157 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
5158 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005159 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5160 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
5161 skip |=
5162 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
5163 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
5164 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005165 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
5166 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005167 }
5168 return skip;
5169}
5170
John Zulauf1686f232019-07-09 16:27:11 -06005171void ValidationStateTracker::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage,
5172 VkImageLayout srcImageLayout, VkBuffer dstBuffer,
5173 uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005174 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005175 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005176 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005177
John Zulauf1686f232019-07-09 16:27:11 -06005178 // Update bindings between buffer/image and cmd buffer
5179 AddCommandBufferBindingImage(cb_node, src_image_state);
5180 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
5181}
5182void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
5183 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
5184 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
5185
5186 auto cb_node = GetCBState(commandBuffer);
5187 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06005188 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005189 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005190 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005191 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005192}
5193
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005194bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5195 VkImageLayout dstImageLayout, uint32_t regionCount,
5196 const VkBufferImageCopy *pRegions) {
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005197 const auto cb_node = GetCBState(commandBuffer);
5198 const auto src_buffer_state = GetBufferState(srcBuffer);
5199 const auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005200
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005201 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005202
5203 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005204 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005205
5206 // Command pool must support graphics, compute, or transfer operations
John Zulaufe3d1c8a2019-08-12 14:34:58 -06005207 const auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005208 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005209 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5210 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 -06005211 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005212 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005213 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005214 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005215 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005216 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005217 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005218 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005219 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005220 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005221 skip |=
5222 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5223 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005224 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005225 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5226 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005227 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005228 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5229 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005230 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005231 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5232 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005233 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005234 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005235 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005236 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005237 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5238 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5239 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005240 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005241 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005242 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005243 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005244 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5245 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005246 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5247 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5248 skip |=
5249 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5250 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5251 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005252 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5253 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005254 }
5255 return skip;
5256}
5257
John Zulauf1686f232019-07-09 16:27:11 -06005258void ValidationStateTracker::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5259 VkImageLayout dstImageLayout, uint32_t regionCount,
5260 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005261 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005262 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005263 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005264
John Zulauf1686f232019-07-09 16:27:11 -06005265 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
5266 AddCommandBufferBindingImage(cb_node, dst_image_state);
5267}
5268
5269void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5270 VkImageLayout dstImageLayout, uint32_t regionCount,
5271 const VkBufferImageCopy *pRegions) {
5272 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5273
5274 auto cb_node = GetCBState(commandBuffer);
5275 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005276 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005277 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005278 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005279 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005280}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005281
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005282bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5283 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005284 bool skip = false;
5285 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5286
Dave Houlton1d960ff2018-01-19 12:17:05 -07005287 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005288 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5289 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5290 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005291 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 -06005292 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005293 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005294 }
5295
John Zulaufa26d3c82019-08-14 16:09:08 -06005296 const IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005297 if (!image_entry) {
5298 return skip;
5299 }
5300
Dave Houlton1d960ff2018-01-19 12:17:05 -07005301 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005302 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005303 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5304 "VUID-vkGetImageSubresourceLayout-image-00996",
5305 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005306 }
5307
Dave Houlton1d960ff2018-01-19 12:17:05 -07005308 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005309 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005310 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5311 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5312 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5313 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005314 }
5315
Dave Houlton1d960ff2018-01-19 12:17:05 -07005316 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005317 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005318 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5319 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5320 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5321 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005322 }
5323
Dave Houlton1d960ff2018-01-19 12:17:05 -07005324 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005325 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005326 if (FormatIsMultiplane(img_format)) {
5327 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005328 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005329 if (FormatPlaneCount(img_format) > 2u) {
5330 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005331 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005332 }
5333 if (sub_aspect != (sub_aspect & allowed_flags)) {
5334 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 -06005335 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005336 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005337 ") must be a single-plane specifier flag.",
5338 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005339 }
5340 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005341 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005342 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005343 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005344 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005345 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005346 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005347 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005348 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005349 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 -06005350 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005351 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005352 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005353 }
5354 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005355
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005356 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005357 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005358 }
5359
Mike Weiblen672b58b2017-02-21 14:32:53 -07005360 return skip;
5361}