blob: 3f3846e3e645d5a1218d7c44f3ac43a64ce01943 [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
105IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
106 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
107 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
108 if (conversionInfo) samplerConversion = conversionInfo->conversion;
109 if (image_state) {
110 // A light normalization of the createInfo range
111 auto &sub_res_range = create_info.subresourceRange;
112 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
113 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
114
115 // Cache a full normalization (for "full image/whole image" comparisons)
116 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
117 }
118}
119
Dave Houltond9611312018-11-19 17:03:36 -0700120uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
121 // uint cast applies floor()
122 return 1u + (uint32_t)log2(std::max({height, width, depth}));
123}
124
125uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
126
127uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
128
John Zulauff660ad62019-03-23 07:16:05 -0600129VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
130 const VkImageCreateInfo &image_create_info = image_state.createInfo;
131 VkImageSubresourceRange norm = range;
132 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
133
134 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
135 // <arrayLayers> can potentially alias.
136 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
137 ? image_create_info.extent.depth
138 : image_create_info.arrayLayers;
139 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
140
141 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
142 VkImageAspectFlags &aspect_mask = norm.aspectMask;
143 if (FormatIsMultiplane(image_create_info.format)) {
144 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
145 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
146 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
147 if (FormatPlaneCount(image_create_info.format) > 2) {
148 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
149 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700150 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700151 }
John Zulauff660ad62019-03-23 07:16:05 -0600152 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700153}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700154
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700155template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700156void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700157 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700158 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
159 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
160 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
161 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600162 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700163 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
164 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
165 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700166 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700167}
168
169template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700170void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700171 if (imgpair.subresource.aspectMask & aspectMask) {
172 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700173 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700174 }
175}
176
Tony Barbourdf013b92017-01-25 12:53:48 -0700177// Set the layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600178void CoreChecks::SetLayout(ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700179 auto it = imageLayoutMap.find(imgpair);
180 if (it != imageLayoutMap.end()) {
181 it->second.layout = layout; // Update
182 } else {
183 imageLayoutMap[imgpair].layout = layout; // Insert
184 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700185}
186
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700187bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700188 if (!(imgpair.subresource.aspectMask & aspectMask)) {
189 return false;
190 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700191 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
192 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600193 auto imgsubIt = imageLayoutMap.find(imgpair);
194 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700195 return false;
196 }
197 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200198 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 -0600199 kVUID_Core_DrawState_InvalidLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -0600200 "Cannot query for %s layout when combined aspect mask %d has multiple layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700201 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700202 string_VkImageLayout(imgsubIt->second.layout));
203 }
204 layout = imgsubIt->second.layout;
205 return true;
206}
207
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700208// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700209bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700210 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700211 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
212 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
213 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
214 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600215 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700216 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
217 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
218 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700219 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700220 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
221 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600222 auto imgsubIt = imageLayoutMap.find(imgpair);
223 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700224 layout = imgsubIt->second.layout;
225 }
226 return true;
227}
228
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700229bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600230 auto sub_data = imageSubresourceMap.find(image);
231 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700232 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700233 if (!image_state) return false;
234 bool ignoreGlobal = false;
235 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
236 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
237 ignoreGlobal = true;
238 }
239 for (auto imgsubpair : sub_data->second) {
240 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600241 auto img_data = imageLayoutMap.find(imgsubpair);
242 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700243 layouts.push_back(img_data->second.layout);
244 }
245 }
246 return true;
247}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700248
John Zulauf3b04ebd2019-07-18 14:08:11 -0600249bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair, VkImageLayout &layout,
250 const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700251 if (!(imgpair.subresource.aspectMask & aspectMask)) {
252 return false;
253 }
254 imgpair.subresource.aspectMask = aspectMask;
255 auto imgsubIt = imageLayoutMap.find(imgpair);
256 if (imgsubIt == imageLayoutMap.end()) {
257 return false;
258 }
259 layout = imgsubIt->second.layout;
260 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700261}
Tony Barbourdf013b92017-01-25 12:53:48 -0700262
263// find layout in supplied map
John Zulauf3b04ebd2019-07-18 14:08:11 -0600264bool CoreChecks::FindLayout(const ImageSubresPairLayoutMap &imageLayoutMap, ImageSubresourcePair imgpair,
265 VkImageLayout &layout) const {
Tony Barbourdf013b92017-01-25 12:53:48 -0700266 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
267 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
268 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
269 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
270 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600271 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700272 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
273 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
274 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
275 }
276 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700277 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
278 imgpair = {imgpair.image, false, VkImageSubresource()};
279 auto imgsubIt = imageLayoutMap.find(imgpair);
280 if (imgsubIt == imageLayoutMap.end()) return false;
281 layout = imgsubIt->second.layout;
282 }
283 return true;
284}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700285
286// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700287void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700288 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600289 auto data = imageLayoutMap.find(imgpair);
290 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700291 data->second.layout = layout; // Update
292 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600293 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700294 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600295 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700296 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
297 if (subresource == image_subresources.end()) {
298 image_subresources.push_back(imgpair);
299 }
300}
301
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600302// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600303void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600304 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
305 VkImageLayout expected_layout) {
306 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
307 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600308 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600309 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700310 }
311}
John Zulauff660ad62019-03-23 07:16:05 -0600312
313// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600314void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
Jeff Bolz3e333222019-08-10 23:00:38 -0500315 if (disabled.image_layout_validation) {
316 return;
317 }
John Zulauff660ad62019-03-23 07:16:05 -0600318 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
319 if (image_state) {
320 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600321 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600322 }
323}
324
325// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600326void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600327 const VkImageSubresourceRange &range, VkImageLayout layout) {
328 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
329 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600330 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600331}
332
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600333void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600334 VkImageLayout layout) {
335 const IMAGE_STATE *image_state = GetImageState(image);
336 if (!image_state) return;
337 SetImageInitialLayout(cb_node, *image_state, range, layout);
338};
339
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600340void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600341 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
342 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600343}
Dave Houltonddd65c52018-05-08 14:58:01 -0600344
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600345// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600346void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600347 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
348 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600349
John Zulauff660ad62019-03-23 07:16:05 -0600350 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600351 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
352 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600353 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 -0600354 sub_range.baseArrayLayer = 0;
355 sub_range.layerCount = image_state->createInfo.extent.depth;
356 }
357
John Zulauff660ad62019-03-23 07:16:05 -0600358 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600359}
360
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700361bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
362 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700363 VkFramebuffer framebuffer, VkRenderPass renderpass,
364 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100365 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700366 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100367 const char *vuid;
368 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
369
370 if (!image_state) {
371 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
372 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
locke-lunarg9edc2812019-06-17 23:18:52 -0600373 "Render Pass begin with %s uses %s where pAttachments[%" PRIu32 "] = %s, which refers to an invalid image",
Lockee9aeebf2019-03-03 23:50:08 -0700374 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
375 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100376 return skip;
377 }
378
379 auto image_usage = image_state->createInfo.usage;
380
381 // Check for layouts that mismatch image usages in the framebuffer
382 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
383 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
384 skip |=
385 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 -0600386 "Layout/usage mismatch for attachment %u in %s"
387 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100388 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600389 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
390 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100391 }
392
393 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
394 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
395 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
396 skip |=
397 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 -0600398 "Layout/usage mismatch for attachment %u in %s"
399 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600401 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
402 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100403 }
404
405 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
406 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
407 skip |=
408 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 -0600409 "Layout/usage mismatch for attachment %u in %s"
410 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100411 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600412 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
413 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 }
415
416 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
417 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
418 skip |=
419 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 -0600420 "Layout/usage mismatch for attachment %u in %s"
421 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100422 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600423 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
424 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100425 }
426
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600427 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100428 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
429 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
430 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
432 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
433 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700434 skip |= log_msg(
435 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 -0600436 "Layout/usage mismatch for attachment %u in %s"
437 " - the %s is %s but the image attached to %s via %s"
Lockee9aeebf2019-03-03 23:50:08 -0700438 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600439 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
440 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 }
442 } else {
443 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
444 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
445 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
446 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
447 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
448 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
locke-lunarg9edc2812019-06-17 23:18:52 -0600449 "Layout/usage mismatch for attachment %u in %s"
450 " - the %s is %s but the image attached to %s via %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600452 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
453 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700454 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100455 }
456 }
457 return skip;
458}
459
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600460bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700461 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700462 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600463 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700464 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700465 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorc9057422019-07-23 12:15:52 +0100466 const VkImageView *attachments = framebufferInfo.pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100467
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700468 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100469 auto framebuffer = framebuffer_state->framebuffer;
470
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700471 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600472 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 -0600473 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700474 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700475 }
John Zulauf8e308292018-09-21 11:34:37 -0600476
Tobias Hectorc9057422019-07-23 12:15:52 +0100477 const auto *attachmentInfo = lvl_find_in_chain<VkRenderPassAttachmentBeginInfoKHR>(pRenderPassBegin->pNext);
478 if (((framebufferInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT_KHR) != 0) && attachmentInfo != nullptr) {
479 attachments = attachmentInfo->pAttachments;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100480 }
481
Tobias Hectorc9057422019-07-23 12:15:52 +0100482 if (attachments != nullptr) {
483 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
484 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
485 auto image_view = attachments[i];
486 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100487
Tobias Hectorc9057422019-07-23 12:15:52 +0100488 if (!view_state) {
489 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
490 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
491 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
492 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
493 report_data->FormatHandle(image_view).c_str());
494 continue;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100495 }
Tobias Hectorc9057422019-07-23 12:15:52 +0100496
497 const VkImage image = view_state->create_info.image;
498 const IMAGE_STATE *image_state = GetImageState(image);
499
500 if (!image_state) {
501 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
502 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
503 "vkCmdBeginRenderPass(): %s pAttachments[%" PRIu32 "] = %s references non-extant %s.",
504 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
505 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
506 continue;
507 }
508 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
509 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
510
511 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
512 // in common with the non-const version.)
513 const ImageSubresourceLayoutMap *subresource_map =
514 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
515
516 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
517 LayoutUseCheckAndMessage layout_check(subresource_map);
518 bool subres_skip = false;
519 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
520 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
521 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
522 subres_skip |=
523 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
524 kVUID_Core_DrawState_InvalidRenderpass,
525 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
526 "and the %s layout of the attachment is %s. The layouts must match, or the render "
527 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
528 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
529 string_VkImageLayout(layout_check.layout));
530 }
531 return !subres_skip; // quit checking subresources once we fail once
532 };
533
534 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
535 skip |= subres_skip;
536 }
537
538 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view,
539 framebuffer, render_pass, i, "initial layout");
540
541 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer,
542 render_pass, i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100543 }
544
Tobias Hectorc9057422019-07-23 12:15:52 +0100545 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
546 auto &subpass = pRenderPassInfo->pSubpasses[j];
547 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
548 auto &attachment_ref = subpass.pInputAttachments[k];
549 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
550 auto image_view = attachments[attachment_ref.attachment];
551 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100552
Tobias Hectorc9057422019-07-23 12:15:52 +0100553 if (view_state) {
554 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700555 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
556 framebuffer, render_pass, attachment_ref.attachment,
Tobias Hectorc9057422019-07-23 12:15:52 +0100557 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100558 }
559 }
560 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100561
Tobias Hectorc9057422019-07-23 12:15:52 +0100562 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
563 auto &attachment_ref = subpass.pColorAttachments[k];
564 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
565 auto image_view = attachments[attachment_ref.attachment];
566 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100567
Tobias Hectorc9057422019-07-23 12:15:52 +0100568 if (view_state) {
569 auto image = view_state->create_info.image;
570 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
571 framebuffer, render_pass, attachment_ref.attachment,
572 "color attachment layout");
573 if (subpass.pResolveAttachments) {
574 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
575 rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
576 attachment_ref.attachment, "resolve attachment layout");
577 }
578 }
579 }
580 }
581
582 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
583 auto &attachment_ref = *subpass.pDepthStencilAttachment;
584 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
585 auto image_view = attachments[attachment_ref.attachment];
586 auto view_state = GetImageViewState(image_view);
587
588 if (view_state) {
589 auto image = view_state->create_info.image;
590 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
591 framebuffer, render_pass, attachment_ref.attachment,
592 "input attachment layout");
593 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100594 }
595 }
596 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700597 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600598 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700599}
600
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600601void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700602 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700603 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700604 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600605 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600606 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600607 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700608 }
609}
610
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600611void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
612 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700613 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700614
615 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700616 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700617 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700618 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700619 }
620 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700621 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700622 }
623 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700624 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700625 }
626 }
627}
628
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700629// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
630// 1. Transition into initialLayout state
631// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600632void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700633 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700634 // First transition into initialLayout
635 auto const rpci = render_pass_state->createInfo.ptr();
636 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700637 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600638 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600639 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600640 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700641 }
642 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700643 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700644}
645
Dave Houlton10b39482017-03-16 13:18:15 -0600646bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600647 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600648 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600649 }
650 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600651 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600652 }
653 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600654 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600655 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700656 if (0 !=
657 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
658 if (FormatPlaneCount(format) == 1) return false;
659 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600660 return true;
661}
662
Mike Weiblen62d08a32017-03-07 22:18:27 -0700663// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Petr Krausad0096a2019-08-09 18:35:04 +0200664bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier &img_barrier, bool new_not_old,
665 VkImageUsageFlags usage_flags, const char *func_name,
666 const char *barrier_pname) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700667 bool skip = false;
Petr Krausad0096a2019-08-09 18:35:04 +0200668 const VkImageLayout layout = (new_not_old) ? img_barrier.newLayout : img_barrier.oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600669 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700670
671 switch (layout) {
672 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
673 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600674 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700675 }
676 break;
677 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
678 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600679 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700680 }
681 break;
682 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
683 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600684 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700685 }
686 break;
687 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
688 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600689 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700690 }
691 break;
692 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
693 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600694 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695 }
696 break;
697 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
698 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600699 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700700 }
701 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600702 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500703 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
704 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
705 }
706 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700707 default:
708 // Other VkImageLayout values do not have VUs defined in this context.
709 break;
710 }
711
Dave Houlton8e9f6542018-05-18 12:18:22 -0600712 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600713 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 +0200714 HandleToUint64(img_barrier.image), msg_code,
715 "%s: Image barrier %s %s Layout=%s is not compatible with %s usage flags 0x%" PRIx32 ".", func_name,
716 barrier_pname, ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
717 report_data->FormatHandle(img_barrier.image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700718 }
719 return skip;
720}
721
722// Verify image barriers are compatible with the images they reference.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600723bool CoreChecks::ValidateBarriersToImages(CMD_BUFFER_STATE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700724 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700725 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700726
Petr Krausad0096a2019-08-09 18:35:04 +0200727 // Scoreboard for checking for duplicate and inconsistent barriers to images
728 struct ImageBarrierScoreboardEntry {
729 uint32_t index;
730 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
731 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
732 const VkImageMemoryBarrier *barrier;
733 };
734 using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
735 using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
736
John Zulauf463c51e2018-05-31 13:29:20 -0600737 // Scoreboard for duplicate layout transition barriers within the list
738 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
739 ImageBarrierScoreboardImageMap layout_transitions;
740
Mike Weiblen62d08a32017-03-07 22:18:27 -0700741 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +0200742 const auto &img_barrier = pImageMemoryBarriers[i];
743 const std::string barrier_pname = "pImageMemoryBarrier[" + std::to_string(i) + "]";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700744
John Zulauf463c51e2018-05-31 13:29:20 -0600745 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
746 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
747 // at a per sub-resource level
Petr Krausad0096a2019-08-09 18:35:04 +0200748 if (img_barrier.oldLayout != img_barrier.newLayout) {
749 const ImageBarrierScoreboardEntry new_entry{i, &img_barrier};
750 const auto image_it = layout_transitions.find(img_barrier.image);
John Zulauf463c51e2018-05-31 13:29:20 -0600751 if (image_it != layout_transitions.end()) {
752 auto &subres_map = image_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200753 auto subres_it = subres_map.find(img_barrier.subresourceRange);
John Zulauf463c51e2018-05-31 13:29:20 -0600754 if (subres_it != subres_map.end()) {
755 auto &entry = subres_it->second;
Petr Krausad0096a2019-08-09 18:35:04 +0200756 if ((entry.barrier->newLayout != img_barrier.oldLayout) &&
757 (img_barrier.oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
758 const VkImageSubresourceRange &range = img_barrier.subresourceRange;
John Zulauf463c51e2018-05-31 13:29:20 -0600759 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700760 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
761 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Petr Krausad0096a2019-08-09 18:35:04 +0200762 "%s: %s conflicts with earlier entry pImageMemoryBarrier[%u]. %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600763 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
764 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200765 func_name, barrier_pname.c_str(), entry.index, report_data->FormatHandle(img_barrier.image).c_str(),
766 range.aspectMask, range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
767 string_VkImageLayout(img_barrier.oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600768 }
769 entry = new_entry;
770 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200771 subres_map[img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600772 }
773 } else {
Petr Krausad0096a2019-08-09 18:35:04 +0200774 layout_transitions[img_barrier.image][img_barrier.subresourceRange] = new_entry;
John Zulauf463c51e2018-05-31 13:29:20 -0600775 }
776 }
777
Petr Krausad0096a2019-08-09 18:35:04 +0200778 auto image_state = GetImageState(img_barrier.image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600779 if (image_state) {
780 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Petr Krausad0096a2019-08-09 18:35:04 +0200781 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name, barrier_pname.c_str());
782 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name, barrier_pname.c_str());
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600783
784 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
785 if (image_state->layout_locked) {
786 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600787 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700788 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Petr Krausad0096a2019-08-09 18:35:04 +0200789 HandleToUint64(img_barrier.image), 0,
locke-lunarg9edc2812019-06-17 23:18:52 -0600790 "Attempting to transition shared presentable %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600791 " 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 +0200792 report_data->FormatHandle(img_barrier.image).c_str(), string_VkImageLayout(img_barrier.oldLayout),
793 string_VkImageLayout(img_barrier.newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600794 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600795
John Zulauff660ad62019-03-23 07:16:05 -0600796 VkImageCreateInfo *image_create_info = &image_state->createInfo;
797 // For a Depth/Stencil image both aspects MUST be set
798 if (FormatIsDepthAndStencil(image_create_info->format)) {
Petr Krausad0096a2019-08-09 18:35:04 +0200799 auto const aspect_mask = img_barrier.subresourceRange.aspectMask;
John Zulauff660ad62019-03-23 07:16:05 -0600800 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
801 if ((aspect_mask & ds_mask) != (ds_mask)) {
802 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 +0200803 HandleToUint64(img_barrier.image), "VUID-VkImageMemoryBarrier-image-01207",
804 "%s: Image barrier %s references %s of format %s that must have the depth and stencil "
John Zulauff660ad62019-03-23 07:16:05 -0600805 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
Petr Krausad0096a2019-08-09 18:35:04 +0200806 func_name, barrier_pname.c_str(), report_data->FormatHandle(img_barrier.image).c_str(),
John Zulauff660ad62019-03-23 07:16:05 -0600807 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700808 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700809 }
John Zulauff660ad62019-03-23 07:16:05 -0600810
Petr Krausad0096a2019-08-09 18:35:04 +0200811 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier.image);
812 if (img_barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
John Zulauff660ad62019-03-23 07:16:05 -0600813 // TODO: Set memory invalid which is in mem_tracker currently
814 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
815 // subresource.
816 } else if (subresource_map) {
817 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600818 LayoutUseCheckAndMessage layout_check(subresource_map);
Petr Krausad0096a2019-08-09 18:35:04 +0200819 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier.subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600820 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600821 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
Petr Krausad0096a2019-08-09 18:35:04 +0200822 if (!layout_check.Check(subres, img_barrier.oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600823 subres_skip =
824 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
825 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
locke-lunarg9edc2812019-06-17 23:18:52 -0600826 "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 -0600827 "%s layout is %s.",
Petr Krausad0096a2019-08-09 18:35:04 +0200828 report_data->FormatHandle(img_barrier.image).c_str(), subres.aspectMask, subres.mipLevel,
829 subres.arrayLayer, string_VkImageLayout(img_barrier.oldLayout), layout_check.message,
John Zulauff660ad62019-03-23 07:16:05 -0600830 string_VkImageLayout(layout_check.layout));
831 }
832 return !subres_skip;
833 };
834 subresource_map->ForRange(normalized_isr, subres_callback);
835 skip |= subres_skip;
836 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700837 }
838 }
839 return skip;
840}
841
Petr Krausad0096a2019-08-09 18:35:04 +0200842bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, const VkImageMemoryBarrier &barrier) {
843 if (!IsTransferOp(&barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700844
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600845 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
Petr Krausad0096a2019-08-09 18:35:04 +0200846 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, &barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700847}
848
John Zulauf6b4aae82018-05-09 13:03:36 -0600849template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600850bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700851 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600852 using BarrierRecord = QFOTransferBarrier<Barrier>;
853 bool skip = false;
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600854 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600855 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
856 const char *barrier_name = BarrierRecord::BarrierName();
857 const char *handle_name = BarrierRecord::HandleName();
858 const char *transfer_type = nullptr;
859 for (uint32_t b = 0; b < barrier_count; b++) {
860 if (!IsTransferOp(&barriers[b])) continue;
861 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700862 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
863 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600864 const auto found = barrier_sets.release.find(barriers[b]);
865 if (found != barrier_sets.release.cend()) {
866 barrier_record = &(*found);
867 transfer_type = "releasing";
868 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600869 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
870 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600871 const auto found = barrier_sets.acquire.find(barriers[b]);
872 if (found != barrier_sets.acquire.cend()) {
873 barrier_record = &(*found);
874 transfer_type = "acquiring";
875 }
876 }
877 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700878 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
879 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
880 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
881 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
882 func_name, barrier_name, b, transfer_type, handle_name,
883 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
884 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600885 }
886 }
887 return skip;
888}
889
890template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600891void CoreChecks::RecordQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600892 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600893 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
894 for (uint32_t b = 0; b < barrier_count; b++) {
895 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700896 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
897 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600898 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600899 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
900 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600901 barrier_sets.acquire.emplace(barriers[b]);
902 }
903 }
904}
905
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600906bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state,
907 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700908 uint32_t imageMemBarrierCount,
909 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600910 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700911 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
912 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600913 return skip;
914}
915
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600916void CoreChecks::RecordBarriersQFOTransfers(CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700917 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
918 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700919 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
920 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600921}
922
923template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600924bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600925 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600926 // Record to the scoreboard or report that we have a duplication
927 bool skip = false;
928 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
929 if (!inserted.second && inserted.first->second != cb_state) {
930 // 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 -0700931 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
932 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
933 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
locke-lunarg9edc2812019-06-17 23:18:52 -0600934 " duplicates existing barrier submitted in this batch from %s.",
Lockee9aeebf2019-03-03 23:50:08 -0700935 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
936 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -0600937 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600938 }
939 return skip;
940}
941
942template <typename Barrier>
John Zulauf3b04ebd2019-07-18 14:08:11 -0600943bool CoreChecks::ValidateQueuedQFOTransferBarriers(const CMD_BUFFER_STATE *cb_state,
944 QFOTransferCBScoreboards<Barrier> *scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600945 using BarrierRecord = QFOTransferBarrier<Barrier>;
946 using TypeTag = typename BarrierRecord::Tag;
947 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600948 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700949 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600950 const char *barrier_name = BarrierRecord::BarrierName();
951 const char *handle_name = BarrierRecord::HandleName();
952 // No release should have an extant duplicate (WARNING)
953 for (const auto &release : cb_barriers.release) {
954 // Check the global pending release barriers
955 const auto set_it = global_release_barriers.find(release.handle);
956 if (set_it != global_release_barriers.cend()) {
957 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
958 const auto found = set_for_handle.find(release);
959 if (found != set_for_handle.cend()) {
960 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
961 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700962 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600963 " to dstQueueFamilyIndex %" PRIu32
964 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700965 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600966 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
967 }
968 }
969 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
970 }
971 // Each acquire must have a matching release (ERROR)
972 for (const auto &acquire : cb_barriers.acquire) {
973 const auto set_it = global_release_barriers.find(acquire.handle);
974 bool matching_release_found = false;
975 if (set_it != global_release_barriers.cend()) {
976 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
977 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
978 }
979 if (!matching_release_found) {
980 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
981 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700982 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
983 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
984 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600985 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
986 }
987 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
988 }
989 return skip;
990}
991
John Zulauf3b04ebd2019-07-18 14:08:11 -0600992bool CoreChecks::ValidateQueuedQFOTransfers(const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700993 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
John Zulauf3b04ebd2019-07-18 14:08:11 -0600994 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) const {
John Zulauf6b4aae82018-05-09 13:03:36 -0600995 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700996 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
997 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600998 return skip;
999}
1000
1001template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001002void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001003 using BarrierRecord = QFOTransferBarrier<Barrier>;
1004 using TypeTag = typename BarrierRecord::Tag;
1005 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001006 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001007
1008 // Add release barriers from this submit to the global map
1009 for (const auto &release : cb_barriers.release) {
1010 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1011 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1012 global_release_barriers[release.handle].insert(release);
1013 }
1014
1015 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1016 for (const auto &acquire : cb_barriers.acquire) {
1017 // NOTE: We're not using [] because we don't want to create entries for missing releases
1018 auto set_it = global_release_barriers.find(acquire.handle);
1019 if (set_it != global_release_barriers.end()) {
1020 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1021 set_for_handle.erase(acquire);
1022 if (set_for_handle.size() == 0) { // Clean up empty sets
1023 global_release_barriers.erase(set_it);
1024 }
1025 }
1026 }
1027}
1028
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001029void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001030 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1031 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001032}
1033
John Zulauf6b4aae82018-05-09 13:03:36 -06001034// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001035void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001036
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001037void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001038 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001039 for (uint32_t i = 0; i < memBarrierCount; ++i) {
Petr Krausad0096a2019-08-09 18:35:04 +02001040 const auto &mem_barrier = pImgMemBarriers[i];
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001041
Chris Forbes4de4b132017-08-21 11:27:08 -07001042 // For ownership transfers, the barrier is specified twice; as a release
1043 // operation on the yielding queue family, and as an acquire operation
1044 // on the acquiring queue family. This barrier may also include a layout
1045 // transition, which occurs 'between' the two operations. For validation
1046 // purposes it doesn't seem important which side performs the layout
1047 // transition, but it must not be performed twice. We'll arbitrarily
1048 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001049 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001050 continue;
1051 }
1052
Petr Krausad0096a2019-08-09 18:35:04 +02001053 auto *image_state = GetImageState(mem_barrier.image);
John Zulauff660ad62019-03-23 07:16:05 -06001054 if (!image_state) continue;
1055
Petr Krausad0096a2019-08-09 18:35:04 +02001056 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier.subresourceRange);
John Zulauff660ad62019-03-23 07:16:05 -06001057 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001058
Dave Houltonb3f4b282018-02-22 16:25:16 -07001059 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1060 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1061 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001062 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1063 normalized_isr.baseArrayLayer = 0;
1064 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001065 }
1066
Petr Krausad0096a2019-08-09 18:35:04 +02001067 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier.newLayout, mem_barrier.oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001068 }
1069}
1070
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001071bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1072 const VkImageSubresourceRange &range, VkImageAspectFlags aspect_mask,
1073 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1074 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07001075 if (disabled.image_layout_validation) return false;
John Zulauff660ad62019-03-23 07:16:05 -06001076 assert(cb_node);
1077 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001078 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001079 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001080
John Zulauff660ad62019-03-23 07:16:05 -06001081 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1082 if (subresource_map) {
1083 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001084 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1085 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001086 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001087 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001088 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001089 subres_skip |=
1090 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1091 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001092 "%s: Cannot use %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
John Zulauff660ad62019-03-23 07:16:05 -06001093 "%s layout %s.",
1094 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1095 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001096 }
John Zulauff660ad62019-03-23 07:16:05 -06001097 return !subres_skip;
1098 };
1099 subresource_map->ForRange(range, subresource_cb);
1100 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001101 }
John Zulauff660ad62019-03-23 07:16:05 -06001102
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001103 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1104 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1105 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001106 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1107 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001108 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001109 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001110 kVUID_Core_DrawState_InvalidImageLayout,
locke-lunarg9edc2812019-06-17 23:18:52 -06001111 "%s: For optimal performance %s layout should be %s instead of GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001112 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001113 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001114 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001115 if (image_state->shared_presentable) {
1116 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001117 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1118 layout_invalid_msg_code,
1119 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1120 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001121 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001122 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001123 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001124 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001125 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 -07001126 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
locke-lunarg9edc2812019-06-17 23:18:52 -06001127 "%s: Layout for %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
Lockee9aeebf2019-03-03 23:50:08 -07001128 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1129 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001130 }
1131 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001132 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001133}
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001134bool CoreChecks::VerifyImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001135 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1136 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001137 const char *layout_mismatch_msg_code, bool *error) const {
John Zulauff660ad62019-03-23 07:16:05 -06001138 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1139 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1140}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001141
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001142void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001143 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001144 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001145 if (!renderPass) return;
1146
Tobias Hectorbbb12282018-10-22 15:17:59 +01001147 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001148 if (framebuffer_state) {
1149 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001150 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001151 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001152 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001153 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001154 }
1155 }
1156}
Dave Houltone19e20d2018-02-02 16:32:41 -07001157
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001158#ifdef VK_USE_PLATFORM_ANDROID_KHR
1159// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1160// This could also move into a seperate core_validation_android.cpp file... ?
1161
1162//
1163// AHB-specific validation within non-AHB APIs
1164//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001165bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001166 bool skip = false;
1167
1168 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1169 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001170 if (0 != ext_fmt_android->externalFormat) {
1171 if (VK_FORMAT_UNDEFINED != create_info->format) {
1172 skip |=
1173 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1174 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001175 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001176 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1177 }
1178
1179 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1181 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001182 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001183 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1184 }
1185
1186 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1187 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1188 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001189 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001190 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1191 }
1192
1193 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1194 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1195 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001196 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001197 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1198 }
1199 }
1200
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001201 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001202 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1203 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001204 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001205 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1206 }
1207 }
1208
Dave Houltond9611312018-11-19 17:03:36 -07001209 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001210 if (VK_FORMAT_UNDEFINED == create_info->format) {
1211 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1212 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001213 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001214 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1215 }
1216 }
1217
1218 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1219 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1220 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001221 skip |=
1222 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1223 "VUID-VkImageCreateInfo-pNext-02393",
1224 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1225 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1226 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001227 }
1228
1229 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1231 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001232 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001233 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1234 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1235 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1236 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001237 }
1238
1239 return skip;
1240}
1241
John Zulauf7eeb6f72019-06-17 11:56:36 -06001242void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001243 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1244 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1245 is_node->imported_ahb = true;
1246 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001247 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001248 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001249 is_node->has_ahb_format = true;
1250 is_node->ahb_format = ext_fmt_android->externalFormat;
1251 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001252}
1253
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001254bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001255 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001256 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001257
1258 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001259 if (VK_FORMAT_UNDEFINED != create_info->format) {
1260 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1261 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1262 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1263 "format member is %s.",
1264 string_VkFormat(create_info->format));
1265 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001266
Dave Houltond9611312018-11-19 17:03:36 -07001267 // Chain must include a compatible ycbcr conversion
1268 bool conv_found = false;
1269 uint64_t external_format = 0;
1270 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1271 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001272 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001273 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001274 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001275 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001276 }
Dave Houltond9611312018-11-19 17:03:36 -07001277 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001278 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001279 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 -07001280 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1281 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1282 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1283 }
1284
1285 // Errors in create_info swizzles
1286 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1287 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1288 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1289 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1290 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1291 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1292 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1293 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001294 }
1295 }
Dave Houltond9611312018-11-19 17:03:36 -07001296
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001297 return skip;
1298}
1299
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001300bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001301 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001303 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1305 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1306 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001307 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001308 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1309 "bound to memory.");
1310 }
1311 return skip;
1312}
1313
1314#else
1315
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001316bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001317 return false;
1318}
1319
John Zulauf7eeb6f72019-06-17 11:56:36 -06001320void ValidationStateTracker::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001321
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001322bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001323
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001324bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001325
1326#endif // VK_USE_PLATFORM_ANDROID_KHR
1327
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001328bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1329 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001330 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001331
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001332 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001333 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001334 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1335 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1336 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1337 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001338 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001339 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001340 }
1341
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001342 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1343 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1344 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1345 "VUID-VkImageCreateInfo-flags-00949",
1346 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1347 "flag bit is set");
1348 }
1349
1350 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1351 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1352 "VUID-VkImageCreateInfo-imageType-00954",
1353 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1354 "height (%d) and arrayLayers (%d) must be >= 6.",
1355 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1356 }
Dave Houlton130c0212018-01-29 13:39:56 -07001357 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001358
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001359 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001360 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1361 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1362 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001363 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 +00001364 "VUID-VkImageCreateInfo-usage-00964",
1365 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1366 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001367 }
1368
1369 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001370 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 +00001371 "VUID-VkImageCreateInfo-usage-00965",
1372 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1373 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001374 }
1375
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001376 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001377 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001378 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001379#ifdef VK_USE_PLATFORM_ANDROID_KHR
1380 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1381#endif // VK_USE_PLATFORM_ANDROID_KHR
1382 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1383 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1384 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001385 } else {
1386 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1387 const char *format_string = string_VkFormat(pCreateInfo->format);
1388 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1389 "VUID-VkImageCreateInfo-mipLevels-02255",
1390 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1391 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1392 }
Dave Houlton130c0212018-01-29 13:39:56 -07001393
Dave Houltona585d132019-01-18 13:05:42 -07001394 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1395 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1396 (uint64_t)pCreateInfo->samples;
1397 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001398
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001399 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001400 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001401 uint64_t ig_mask = imageGranularity - 1;
1402 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001403
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001404 if (total_size > format_limits.maxResourceSize) {
1405 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1406 kVUID_Core_Image_InvalidFormatLimitsViolation,
1407 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1408 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1409 total_size, format_limits.maxResourceSize);
1410 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001411
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001412 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1413 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1414 "VUID-VkImageCreateInfo-arrayLayers-02256",
1415 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1416 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1417 }
1418
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001419 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1420 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001421 skip |= log_msg(
1422 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1423 "VUID-VkImageCreateInfo-format-02653",
1424 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1425 pCreateInfo->arrayLayers);
1426 }
1427
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001428 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1429 skip |=
1430 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1431 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001432 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001433 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001434 }
1435
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001436 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001437 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 -06001438 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001439 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1440 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001441 }
1442
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001443 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001444 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1445 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1446 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1447 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001448 skip |=
1449 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1450 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1451 "format must be block, ETC or ASTC compressed, but is %s",
1452 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001453 }
1454 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1455 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001456 skip |=
1457 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1458 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1459 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001460 }
1461 }
1462 }
1463
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001464 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001465 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1466 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1467 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001468 }
1469
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001470 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001471}
1472
John Zulauf7eeb6f72019-06-17 11:56:36 -06001473void ValidationStateTracker::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1474 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001475 if (VK_SUCCESS != result) return;
John Zulauf4db45df2019-07-23 06:10:40 -06001476 std::unique_ptr<IMAGE_STATE> is_node(new IMAGE_STATE(*pImage, pCreateInfo));
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001477 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
John Zulauf4db45df2019-07-23 06:10:40 -06001478 RecordCreateImageANDROID(pCreateInfo, is_node.get());
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001479 }
unknown09edc722019-06-21 15:49:38 -06001480 const auto swapchain_info = lvl_find_in_chain<VkImageSwapchainCreateInfoKHR>(pCreateInfo->pNext);
1481 if (swapchain_info) {
1482 is_node->create_from_swapchain = swapchain_info->swapchain;
1483 }
John Zulauf4db45df2019-07-23 06:10:40 -06001484
1485 bool pre_fetch_memory_reqs = true;
1486#ifdef VK_USE_PLATFORM_ANDROID_KHR
1487 if (is_node->external_format_android) {
1488 // Do not fetch requirements for external memory images
1489 pre_fetch_memory_reqs = false;
1490 }
1491#endif
1492 // Record the memory requirements in case they won't be queried
1493 if (pre_fetch_memory_reqs) {
1494 DispatchGetImageMemoryRequirements(device, *pImage, &is_node->requirements);
1495 }
1496 imageMap.insert(std::make_pair(*pImage, std::move(is_node)));
John Zulauf7eeb6f72019-06-17 11:56:36 -06001497}
1498
1499void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1500 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1501 if (VK_SUCCESS != result) return;
1502
1503 StateTracker::PostCallRecordCreateImage(device, pCreateInfo, pAllocator, pImage, result);
1504
1505 IMAGE_LAYOUT_STATE image_state;
1506 image_state.layout = pCreateInfo->initialLayout;
1507 image_state.format = pCreateInfo->format;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001508 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001509 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001510 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001511}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001512
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001513bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001514 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001515 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001516 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001517 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001518 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001519 }
1520 return skip;
1521}
1522
John Zulauf7eeb6f72019-06-17 11:56:36 -06001523void ValidationStateTracker::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001524 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001525 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001526 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001527 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001528 // Clean up memory mapping, bindings and range references for image
1529 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06001530 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001531 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001532 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001533 }
1534 }
John Zulauf4fea6622019-04-01 11:38:18 -06001535 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001536 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001537 imageMap.erase(image);
John Zulauf7eeb6f72019-06-17 11:56:36 -06001538}
1539
1540void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
1541 // Clean up validation specific data
1542 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001543
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001544 const auto &sub_entry = imageSubresourceMap.find(image);
1545 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001546 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001547 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001548 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001549 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001550 }
John Zulauf7eeb6f72019-06-17 11:56:36 -06001551
1552 // Clean up generic image state
1553 StateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001554}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001555
John Zulauf07288512019-07-05 11:09:50 -06001556bool CoreChecks::ValidateImageAttributes(const IMAGE_STATE *image_state, const VkImageSubresourceRange &range) const {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001557 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001558
1559 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1560 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1561 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 -06001562 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001563 }
1564
Dave Houlton1d2022c2017-03-29 11:43:58 -06001565 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001566 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1567 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 -06001568 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001569 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001570 char const str[] = "vkCmdClearColorImage called with compressed image.";
1571 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 -06001572 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001573 }
1574
1575 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1576 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1577 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 -06001578 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001579 }
1580 return skip;
1581}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001582
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001583uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1584 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1585 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001586 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001587 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001588 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001589 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001590}
1591
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001592uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1593 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1594 uint32_t array_layer_count = range->layerCount;
1595 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1596 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001597 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001598 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001599}
1600
John Zulauf07288512019-07-05 11:09:50 -06001601bool CoreChecks::VerifyClearImageLayout(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *image_state,
1602 const VkImageSubresourceRange &range, VkImageLayout dest_image_layout,
1603 const char *func_name) const {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001604 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001605
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001606 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1607 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001608 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1609 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001610 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 -06001611 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001612 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1613 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001614 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001615 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001616 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001617 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 -06001618 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001619 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1620 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001621
1622 } else {
1623 if (image_state->shared_presentable) {
1624 skip |= log_msg(
1625 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001626 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001627 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1628 string_VkImageLayout(dest_image_layout));
1629 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001630 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001632 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001633 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001634 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001635 } else {
1636 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1637 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001638 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 -06001639 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001640 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1641 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001642 }
1643 }
1644
John Zulauff660ad62019-03-23 07:16:05 -06001645 // Cast to const to prevent creation at validate time.
John Zulauf07288512019-07-05 11:09:50 -06001646 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001647 if (subresource_map) {
1648 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001649 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001650 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001651 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001652 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001653 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001654 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1655 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1656 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1657 } else {
1658 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001659 }
John Zulauff660ad62019-03-23 07:16:05 -06001660 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1661 HandleToUint64(cb_node->commandBuffer), error_code,
1662 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1663 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1664 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001665 }
John Zulauff660ad62019-03-23 07:16:05 -06001666 return !subres_skip;
1667 };
1668 subresource_map->ForRange(normalized_isr, subres_callback);
1669 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670 }
1671
1672 return skip;
1673}
1674
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001675bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1676 const VkClearColorValue *pColor, uint32_t rangeCount,
1677 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001678 bool skip = false;
1679 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulauf07288512019-07-05 11:09:50 -06001680 const auto *cb_node = GetCBState(commandBuffer);
1681 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001682 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001683 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001684 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001685 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001686 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001687 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001688 skip |=
1689 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1690 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001691 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001692 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001693 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001694 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001695 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001696 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1697 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 }
1699 }
1700 return skip;
1701}
1702
John Zulaufeabb4462019-07-05 14:13:03 -06001703void ValidationStateTracker::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image,
1704 VkImageLayout imageLayout, const VkClearColorValue *pColor,
1705 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001706 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001707 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001708 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001709 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001710 }
1711}
1712
1713void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1714 const VkClearColorValue *pColor, uint32_t rangeCount,
1715 const VkImageSubresourceRange *pRanges) {
1716 StateTracker::PreCallRecordCmdClearColorImage(commandBuffer, image, imageLayout, pColor, rangeCount, pRanges);
1717
1718 auto cb_node = GetCBState(commandBuffer);
1719 auto image_state = GetImageState(image);
1720 if (cb_node && image_state) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001721 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001722 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001723 }
1724 }
1725}
1726
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001727bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1728 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1729 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001730 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001731
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001732 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
John Zulaufeabb4462019-07-05 14:13:03 -06001733 const auto *cb_node = GetCBState(commandBuffer);
1734 const auto *image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001735 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001736 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001737 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001738 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001739 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001740 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001741 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001742 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1743 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001744 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001745 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001746 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001747 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001748 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001749 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001750 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001751 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001752 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1753 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001754 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001755 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1756 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001757 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 -06001758 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001759 }
1760 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001761 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001762 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001763 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 -06001764 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001765 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001766 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1767 char const str[] =
1768 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1769 "set.";
1770 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 -06001771 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001772 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001773 }
1774 return skip;
1775}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001776
John Zulaufeabb4462019-07-05 14:13:03 -06001777void ValidationStateTracker::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
1778 VkImageLayout imageLayout,
1779 const VkClearDepthStencilValue *pDepthStencil,
1780 uint32_t rangeCount, const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001781 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001782 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001783 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001784 AddCommandBufferBindingImage(cb_node, image_state);
John Zulaufeabb4462019-07-05 14:13:03 -06001785 }
1786}
1787
1788void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1789 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1790 const VkImageSubresourceRange *pRanges) {
1791 StateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount, pRanges);
1792 auto cb_node = GetCBState(commandBuffer);
1793 auto image_state = GetImageState(image);
1794 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001795 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001796 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001797 }
1798 }
1799}
1800
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001801// Returns true if [x, xoffset] and [y, yoffset] overlap
1802static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1803 bool result = false;
1804 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1805 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1806
1807 if (intersection_max > intersection_min) {
1808 result = true;
1809 }
1810 return result;
1811}
1812
Dave Houltonc991cc92018-03-06 11:08:51 -07001813// Returns true if source area of first copy region intersects dest area of second region
1814// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1815static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001816 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001817
Dave Houltonc991cc92018-03-06 11:08:51 -07001818 // Separate planes within a multiplane image cannot intersect
1819 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001820 return result;
1821 }
1822
Dave Houltonc991cc92018-03-06 11:08:51 -07001823 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1824 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1825 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001826 result = true;
1827 switch (type) {
1828 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001829 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001830 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001831 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001832 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001833 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001834 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001835 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001836 break;
1837 default:
1838 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1839 assert(false);
1840 }
1841 }
1842 return result;
1843}
1844
Dave Houltonfc1a4052017-04-27 14:32:45 -06001845// Returns non-zero if offset and extent exceed image extents
1846static const uint32_t x_bit = 1;
1847static const uint32_t y_bit = 2;
1848static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001849static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001850 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001851 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001852 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1853 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001854 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001855 }
1856 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1857 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001858 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001859 }
1860 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1861 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001862 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001863 }
1864 return result;
1865}
1866
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001867// Test if two VkExtent3D structs are equivalent
1868static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1869 bool result = true;
1870 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1871 (extent->depth != other_extent->depth)) {
1872 result = false;
1873 }
1874 return result;
1875}
1876
Dave Houltonee281a52017-12-08 13:51:02 -07001877// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1878// Destination image texel extents must be adjusted by block size for the dest validation checks
1879VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1880 VkExtent3D adjusted_extent = extent;
1881 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001882 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001883 adjusted_extent.width /= block_size.width;
1884 adjusted_extent.height /= block_size.height;
1885 adjusted_extent.depth /= block_size.depth;
1886 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001887 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001888 adjusted_extent.width *= block_size.width;
1889 adjusted_extent.height *= block_size.height;
1890 adjusted_extent.depth *= block_size.depth;
1891 }
1892 return adjusted_extent;
1893}
1894
Dave Houlton6f9059e2017-05-02 17:15:13 -06001895// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001896static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1897 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001898
1899 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001900 if (mip >= img->createInfo.mipLevels) {
1901 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001902 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001903
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001904 // 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 -06001905 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001906
Dave Houltone48cd112019-01-03 17:01:18 -07001907 // If multi-plane, adjust per-plane extent
1908 if (FormatIsMultiplane(img->createInfo.format)) {
1909 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1910 extent.width /= divisors.width;
1911 extent.height /= divisors.height;
1912 }
1913
Jeff Bolzef40fec2018-09-01 22:04:34 -05001914 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1915 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001916 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001917 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1918 } else {
1919 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1920 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1921 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1922 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001923
Dave Houlton6f9059e2017-05-02 17:15:13 -06001924 // Image arrays have an effective z extent that isn't diminished by mip level
1925 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001926 extent.depth = img->createInfo.arrayLayers;
1927 }
1928
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001929 return extent;
1930}
1931
1932// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001933static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001934 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1935}
1936
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001937// Test if the extent argument has any dimensions set to 0.
1938static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1939 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1940}
1941
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001942// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001943VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001944 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1945 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06001946 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001947 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001948 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001949 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001950 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001951 granularity.width *= block_size.width;
1952 granularity.height *= block_size.height;
1953 }
1954 }
1955 return granularity;
1956}
1957
1958// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1959static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1960 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001961 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1962 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001963 valid = false;
1964 }
1965 return valid;
1966}
1967
1968// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001969bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06001970 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001971 bool skip = false;
1972 VkExtent3D offset_extent = {};
1973 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1974 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1975 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001976 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001977 // 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 -07001978 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001979 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 -04001980 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001981 "%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 "
1982 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001983 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001984 }
1985 } else {
1986 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1987 // integer multiples of the image transfer granularity.
1988 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001989 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 -04001990 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001991 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1992 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001993 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1994 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001995 }
1996 }
1997 return skip;
1998}
1999
2000// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002001bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002002 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002003 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002004 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002005 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002006 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2007 // subresource extent.
2008 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002009 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 -04002010 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002011 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2012 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2013 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2014 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002015 }
2016 } else {
2017 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2018 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2019 // subresource extent dimensions.
2020 VkExtent3D offset_extent_sum = {};
2021 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2022 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2023 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002024 bool x_ok = true;
2025 bool y_ok = true;
2026 bool z_ok = true;
2027 switch (image_type) {
2028 case VK_IMAGE_TYPE_3D:
2029 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2030 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002031 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002032 case VK_IMAGE_TYPE_2D:
2033 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2034 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002035 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002036 case VK_IMAGE_TYPE_1D:
2037 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2038 (subresource_extent->width == offset_extent_sum.width));
2039 break;
2040 default:
2041 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2042 assert(false);
2043 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002044 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002045 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 -04002046 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002047 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2048 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2049 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2050 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2051 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2052 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002053 }
2054 }
2055 return skip;
2056}
2057
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002058bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002059 const uint32_t i, const char *function, const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002060 bool skip = false;
2061 if (mip_level >= img->createInfo.mipLevels) {
2062 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2063 HandleToUint64(cb_node->commandBuffer), vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06002064 "In %s, pRegions[%u].%s.mipLevel is %u, but provided %s has %u mip levels.", function, i, member, mip_level,
2065 report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002066 }
2067 return skip;
2068}
2069
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002070bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002071 const uint32_t layer_count, const uint32_t i, const char *function,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002072 const char *member, const char *vuid) const {
Cort Strattonff1542a2018-05-27 10:49:28 -07002073 bool skip = false;
2074 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2075 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2077 HandleToUint64(cb_node->commandBuffer), vuid,
2078 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
locke-lunarg9edc2812019-06-17 23:18:52 -06002079 "%u, but provided %s has %u array layers.",
Lockee9aeebf2019-03-03 23:50:08 -07002080 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2081 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002082 }
2083 return skip;
2084}
2085
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002086// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002087bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002088 const VkBufferImageCopy *region, const uint32_t i,
2089 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002090 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002091 VkExtent3D granularity = GetScaledItg(cb_node, img);
2092 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002093 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002094 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002095 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002096 return skip;
2097}
2098
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002099// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002100bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002101 const IMAGE_STATE *dst_img, const VkImageCopy *region,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002102 const uint32_t i, const char *function) const {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002103 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002104 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002105 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2106 skip |=
2107 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002108 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002109 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002110 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2111 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002112
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002113 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002114 granularity = GetScaledItg(cb_node, dst_img);
2115 skip |=
2116 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002117 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002118 const VkExtent3D dest_effective_extent =
2119 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002120 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002121 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002122 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002123 return skip;
2124}
2125
Dave Houlton6f9059e2017-05-02 17:15:13 -06002126// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002127bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002128 const IMAGE_STATE *dst_state) const {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129 bool skip = false;
2130
2131 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002132 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002133
2134 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002135 const VkExtent3D src_copy_extent = region.extent;
2136 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002137 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2138
Dave Houlton6f9059e2017-05-02 17:15:13 -06002139 bool slice_override = false;
2140 uint32_t depth_slices = 0;
2141
2142 // Special case for copying between a 1D/2D array and a 3D image
2143 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2144 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002145 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002146 slice_override = (depth_slices != 1);
2147 } 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 -07002148 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002149 slice_override = (depth_slices != 1);
2150 }
2151
2152 // Do all checks on source image
2153 //
2154 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002155 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2156 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 -06002157 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002158 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002159 "be 0 and 1, respectively.",
2160 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002161 }
2162 }
2163
Dave Houlton533be9f2018-03-26 17:08:30 -06002164 // VUID-VkImageCopy-srcImage-01785
2165 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2166 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 -06002167 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002168 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002169 "these must be 0 and 1, respectively.",
2170 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002171 }
2172
Dave Houlton533be9f2018-03-26 17:08:30 -06002173 // VUID-VkImageCopy-srcImage-01787
2174 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2175 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 -06002176 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002177 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2178 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002179 }
2180
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002181 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002182 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002183 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002184 skip |=
2185 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002186 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002187 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002188 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2189 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002190 }
2191 }
2192 } else { // Pre maint 1
2193 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002194 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002195 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 -06002196 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002197 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2198 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002199 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2200 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 }
2202 }
2203 }
2204
Dave Houltonc991cc92018-03-06 11:08:51 -07002205 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002206 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002207 if (FormatIsCompressed(src_state->createInfo.format) ||
2208 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002209 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002211 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2212 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2213 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002214 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002215 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 -07002216 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002218 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002219 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 }
2221
Dave Houlton94a00372017-12-14 15:08:47 -07002222 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002223 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2224 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002225 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002226 skip |=
2227 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002228 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002230 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002231 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 }
2233
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002234 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002235 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2236 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002237 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002238 skip |=
2239 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002240 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002241 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002242 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002243 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002244 }
2245
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002246 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002247 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2248 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002249 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002250 skip |=
2251 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002252 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002253 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002254 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002255 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002256 }
2257 } // Compressed
2258
2259 // Do all checks on dest image
2260 //
2261 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002262 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002263 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 -06002264 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002265 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002266 "these must be 0 and 1, respectively.",
2267 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 }
2269 }
2270
Dave Houlton533be9f2018-03-26 17:08:30 -06002271 // VUID-VkImageCopy-dstImage-01786
2272 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2273 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 -06002274 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002275 "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 -06002276 "and 1, respectively.",
2277 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002278 }
2279
2280 // VUID-VkImageCopy-dstImage-01788
2281 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2282 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 -06002283 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002284 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2285 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002286 }
2287
2288 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002289 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002290 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 -06002291 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002293 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2294 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 }
2296 }
2297 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002298 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002299 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002300 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002301 skip |=
2302 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002303 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002304 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002305 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2306 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 }
2308 }
2309 } else { // Pre maint 1
2310 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002311 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002312 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 -06002313 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002314 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2315 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002316 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2317 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002318 }
2319 }
2320 }
2321
Dave Houltonc991cc92018-03-06 11:08:51 -07002322 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2323 if (FormatIsCompressed(dst_state->createInfo.format) ||
2324 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002325 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002326
2327 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002328 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2329 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2330 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002331 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002332 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 -07002333 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002335 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002336 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002337 }
2338
Dave Houlton94a00372017-12-14 15:08:47 -07002339 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002340 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2341 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002342 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002343 skip |=
2344 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002345 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002346 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002348 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002349 }
2350
Dave Houltonee281a52017-12-08 13:51:02 -07002351 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2352 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2353 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002354 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002355 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 -07002356 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002357 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2358 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002359 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002360 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002361 }
2362
Dave Houltonee281a52017-12-08 13:51:02 -07002363 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2364 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2365 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002366 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002367 skip |=
2368 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002369 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002370 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002371 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002372 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002373 }
2374 } // Compressed
2375 }
2376 return skip;
2377}
2378
Dave Houltonc991cc92018-03-06 11:08:51 -07002379// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002380bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002381 const IMAGE_STATE *dst_image_state, const VkImageCopy region) const {
Dave Houltonc991cc92018-03-06 11:08:51 -07002382 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002383
2384 // Neither image is multiplane
2385 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2386 // If neither image is multi-plane the aspectMask member of src and dst must match
2387 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2388 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002389 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002390 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2391 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 -06002392 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002393 }
2394 } else {
2395 // Source image multiplane checks
2396 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2397 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2398 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2399 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002400 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002401 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 -06002402 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002403 }
2404 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2405 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2406 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002407 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002408 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 -06002409 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002410 }
2411 // Single-plane to multi-plane
2412 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2413 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2414 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002415 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002416 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 -06002417 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002418 }
2419
2420 // Dest image multiplane checks
2421 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2422 aspect = region.dstSubresource.aspectMask;
2423 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2424 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002425 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002426 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 -06002427 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002428 }
2429 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2430 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2431 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002432 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002433 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 -06002434 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002435 }
2436 // Multi-plane to single-plane
2437 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2438 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2439 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002440 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002441 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 -06002442 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002443 }
2444 }
2445
2446 return skip;
2447}
2448
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002449bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2450 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2451 const VkImageCopy *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002452 const auto *cb_node = GetCBState(commandBuffer);
2453 const auto *src_image_state = GetImageState(srcImage);
2454 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002455 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002456
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002457 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002459 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2460
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002461 for (uint32_t i = 0; i < regionCount; i++) {
2462 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002463
2464 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2465 VkExtent3D src_copy_extent = region.extent;
2466 VkExtent3D dst_copy_extent =
2467 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2468
Dave Houlton6f9059e2017-05-02 17:15:13 -06002469 bool slice_override = false;
2470 uint32_t depth_slices = 0;
2471
2472 // Special case for copying between a 1D/2D array and a 3D image
2473 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2474 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2475 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002476 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002477 slice_override = (depth_slices != 1);
2478 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2479 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002480 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 slice_override = (depth_slices != 1);
2482 }
2483
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002484 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2485 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2486 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002487 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002488 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002489 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002490 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002491 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2492 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002493 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002494 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2495 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002496
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002497 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002498 // No chance of mismatch if we're overriding depth slice count
2499 if (!slice_override) {
2500 // The number of depth slices in srcSubresource and dstSubresource must match
2501 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2502 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002503 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2504 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002505 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002506 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2507 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002508 if (src_slices != dst_slices) {
2509 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002510 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002511 << "] do not match";
2512 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002513 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002514 }
2515 }
2516 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002517 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002518 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002519 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002520 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002521 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002522 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002523 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002524 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002525 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002526
Dave Houltonc991cc92018-03-06 11:08:51 -07002527 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002528 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002529 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002530 }
2531
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002532 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002533 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2534 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002535 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002536 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 -06002537 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002538 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002539 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002540
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002541 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002542 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002543 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002544 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002545 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2546 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 -06002547 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002548 }
2549
2550 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002551 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002552 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002553 ss << "vkCmdCopyImage(): pRegion[" << i
2554 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002555 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 -06002556 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002557 }
2558
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002559 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2560 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2561 // 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 -07002562 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2563 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002564 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002565 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002566 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2567 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2568 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002569 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 -06002570 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002571 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002572
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002573 // 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 -07002574 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2575 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002576 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002577 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002578 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2579 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2580 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002581 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 -06002582 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002583 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002584 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002585
Dave Houltonfc1a4052017-04-27 14:32:45 -06002586 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002587 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2588 if (slice_override) src_copy_extent.depth = depth_slices;
2589 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002590 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002591 skip |=
2592 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2593 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2594 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2595 "width [%1d].",
2596 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002597 }
2598
2599 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002600 skip |=
2601 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2602 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2603 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2604 "height [%1d].",
2605 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002606 }
2607 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002608 skip |=
2609 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2610 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2611 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2612 "depth [%1d].",
2613 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002614 }
2615
Dave Houltonee281a52017-12-08 13:51:02 -07002616 // Adjust dest extent if necessary
2617 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2618 if (slice_override) dst_copy_extent.depth = depth_slices;
2619
2620 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002621 if (extent_check & x_bit) {
2622 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 -06002623 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002624 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002625 "width [%1d].",
2626 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002627 }
2628 if (extent_check & y_bit) {
2629 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 -06002630 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002631 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002632 "height [%1d].",
2633 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002634 }
2635 if (extent_check & z_bit) {
2636 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 -06002637 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002638 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002639 "depth [%1d].",
2640 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002641 }
2642
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002643 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2644 // must not overlap in memory
2645 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002646 for (uint32_t j = 0; j < regionCount; j++) {
2647 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002648 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002650 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002651 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 -06002652 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002653 }
2654 }
2655 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002656 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002657
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002658 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2659 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2660 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002661 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2663 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002664 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 -06002665 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666 }
2667 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002668 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002669 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2670 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 -06002671 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002672 }
2673 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002674
Dave Houlton33c22b72017-02-28 13:16:02 -07002675 // Source and dest image sample counts must match
2676 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2677 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2678 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 -06002679 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002680 }
2681
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002682 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2683 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002684 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002685 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2686 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2687 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2688 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002689 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002690 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2691 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2692 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2693 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002694 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002695 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002696 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002697 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2698 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002699 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002700 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2701 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2702 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2703 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2704 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2705 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002706 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002707 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002708 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2709 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002710 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002711 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2712 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002713 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2714 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002715 }
2716
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002717 return skip;
2718}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002719
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002720void ValidationStateTracker::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage,
2721 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
2722 uint32_t regionCount, const VkImageCopy *pRegions) {
2723 auto cb_node = GetCBState(commandBuffer);
2724 auto src_image_state = GetImageState(srcImage);
2725 auto dst_image_state = GetImageState(dstImage);
2726
2727 // Update bindings between images and cmd buffer
2728 AddCommandBufferBindingImage(cb_node, src_image_state);
2729 AddCommandBufferBindingImage(cb_node, dst_image_state);
2730}
2731
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002732void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2733 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2734 const VkImageCopy *pRegions) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06002735 StateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
2736 pRegions);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002737 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002738 auto src_image_state = GetImageState(srcImage);
2739 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002740
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002741 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002742 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002743 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2744 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002745 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002746}
2747
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002748// Returns true if sub_rect is entirely contained within rect
2749static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2750 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2751 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2752 return false;
2753 return true;
2754}
2755
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002756bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002757 const FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment,
2758 const VkRect2D &render_area, uint32_t rect_count,
2759 const VkClearRect *clear_rects) const {
John Zulauf3a548ef2019-02-01 16:14:07 -07002760 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002761 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2762 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002763 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002764 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002765
2766 for (uint32_t j = 0; j < rect_count; j++) {
2767 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002768 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 -07002769 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2770 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2771 "the current render pass instance.",
2772 j);
2773 }
2774
2775 if (image_view_state) {
2776 // The layers specified by a given element of pRects must be contained within every attachment that
2777 // pAttachments refers to
2778 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2779 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2780 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2782 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2783 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2784 "of pAttachment[%d].",
2785 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002786 }
2787 }
2788 }
2789 return skip;
2790}
2791
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002792bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2793 const VkClearAttachment *pAttachments, uint32_t rectCount,
2794 const VkClearRect *pRects) {
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002795 bool skip = false;
Petr Kraus2dffb382019-08-10 02:52:12 +02002796 CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer); // TODO: Should be const, and never modified during validation
2797 if (!cb_node) return skip;
2798
2799 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
2800 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
2801 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
2802 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
2803 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
2804 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2805 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
2806 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2807 // CmdClearAttachments.
2808 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 -07002809 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
locke-lunarg9edc2812019-06-17 23:18:52 -06002810 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
Lockee9aeebf2019-03-03 23:50:08 -07002811 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2812 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002813 }
Petr Kraus2dffb382019-08-10 02:52:12 +02002814 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002815
2816 // Validate that attachment is in reference list of active subpass
2817 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002818 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002819 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002820 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002821 const auto *framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002822 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2823 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002824
John Zulauf3a548ef2019-02-01 16:14:07 -07002825 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2826 auto clear_desc = &pAttachments[attachment_index];
2827 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002828
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002829 if (0 == clear_desc->aspectMask) {
2830 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 -06002831 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002832 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2833 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 -06002834 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002835 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002836 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2837 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2838 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2839 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
locke-lunarg9edc2812019-06-17 23:18:52 -06002840 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2841 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2842 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2843 "and not a valid attachment for %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2844 attachment_index, clear_desc->colorAttachment,
2845 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2846 cb_node->activeSubpass, clear_desc->colorAttachment, color_attachment,
2847 renderpass_attachment_count);
Lockee9aeebf2019-03-03 23:50:08 -07002848
John Zulauff2582972019-02-09 14:53:30 -07002849 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2850 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002851 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002852 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2853 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
locke-lunarg9edc2812019-06-17 23:18:52 -06002854 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for %s"
Lockee9aeebf2019-03-03 23:50:08 -07002855 " subpass %u. colorAttachmentCount=%u",
2856 attachment_index, clear_desc->colorAttachment,
2857 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2858 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002859 }
John Zulauff2582972019-02-09 14:53:30 -07002860 fb_attachment = color_attachment;
2861
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002862 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2863 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2864 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002865 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002866 skip |=
2867 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2868 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002869 }
2870 } else { // Must be depth and/or stencil
2871 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2872 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002873 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002874 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 -07002875 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2876 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002877 }
2878 if (!subpass_desc->pDepthStencilAttachment ||
2879 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2880 skip |= log_msg(
2881 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002882 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002883 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002884 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002885 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002886 }
2887 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002888 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002889 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2890 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002891 } else {
2892 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2893 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2894 if (!clear_rect_copy) {
2895 // We need a copy of the clear rectangles that will persist until the last lambda executes
2896 // but we want to create it as lazily as possible
2897 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002898 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002899
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002900 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002901 CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002902 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002903 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002904 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2905 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002906 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2907 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002908 return skip;
2909 };
2910 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002911 }
2912 }
2913 }
2914 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002915}
2916
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002917bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2918 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2919 const VkImageResolve *pRegions) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06002920 const auto *cb_node = GetCBState(commandBuffer);
2921 const auto *src_image_state = GetImageState(srcImage);
2922 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002923
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002924 bool skip = false;
2925 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002926 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2927 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002928 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002929 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002930 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2931 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002932 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2933 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002934
Cort Stratton7df30962018-05-17 19:45:57 -07002935 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002936 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002937 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002938 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2939 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2940 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002941 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002942 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2943 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002944 // For each region, the number of layers in the image subresource should not be zero
2945 // For each region, src and dest image aspect must be color only
2946 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002947 skip |=
2948 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2949 skip |=
2950 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002951 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002952 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2953 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002954 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002955 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2956 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002957 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2958 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2959 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2960 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2961 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002962 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2963 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002964 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002965 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2966 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002967
2968 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002969 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2970 skip |= log_msg(
2971 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002972 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002973 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002974 }
Cort Stratton7df30962018-05-17 19:45:57 -07002975 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002976 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2977 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2978 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002979 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002980 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 -06002981 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002982 }
2983 }
2984
2985 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2986 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002987 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 -06002988 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002989 }
2990 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2991 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002992 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 -06002993 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002994 }
2995 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2996 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2997 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 -06002998 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002999 }
3000 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3001 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3002 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 -06003003 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003004 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003005 } else {
3006 assert(0);
3007 }
3008 return skip;
3009}
3010
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003011void ValidationStateTracker::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3012 VkImageLayout srcImageLayout, VkImage dstImage,
3013 VkImageLayout dstImageLayout, uint32_t regionCount,
3014 const VkImageResolve *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003015 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003016 auto src_image_state = GetImageState(srcImage);
3017 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003018
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003019 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003020 AddCommandBufferBindingImage(cb_node, src_image_state);
3021 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003022}
3023
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003024bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3025 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3026 const VkImageBlit *pRegions, VkFilter filter) {
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003027 const auto *cb_node = GetCBState(commandBuffer);
3028 const auto *src_image_state = GetImageState(srcImage);
3029 const auto *dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003030
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003031 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003032 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003033 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07003034 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003035 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003036 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003037 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003038 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003039 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003040 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3041 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06003042 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003043 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
3044 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06003045 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003046 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
3047 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003048 skip |=
3049 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003050 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3051 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003052 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003053 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003054 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003055 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003056
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003057 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003058
Dave Houlton33c2d252017-06-09 17:08:32 -06003059 VkFormat src_format = src_image_state->createInfo.format;
3060 VkFormat dst_format = dst_image_state->createInfo.format;
3061 VkImageType src_type = src_image_state->createInfo.imageType;
3062 VkImageType dst_type = dst_image_state->createInfo.imageType;
3063
Cort Stratton186b1a22018-05-01 20:18:06 -04003064 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003065 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003066 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3067 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003068 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003069 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
3070 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
3071 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003072 }
3073
3074 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3075 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 -06003076 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003077 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003078 }
3079
Dave Houlton33c2d252017-06-09 17:08:32 -06003080 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3081 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3082 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 -06003083 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003084 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003085 }
3086
3087 // Validate consistency for unsigned formats
3088 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3089 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003090 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003091 << "the other one must also have unsigned integer format. "
3092 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3093 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 -06003094 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003095 }
3096
3097 // Validate consistency for signed formats
3098 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3099 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003100 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003101 << "the other one must also have signed integer format. "
3102 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3103 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003104 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003105 }
3106
3107 // Validate filter for Depth/Stencil formats
3108 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3109 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003110 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003111 << "then filter must be VK_FILTER_NEAREST.";
3112 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 -06003113 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003114 }
3115
3116 // Validate aspect bits and formats for depth/stencil images
3117 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3118 if (src_format != dst_format) {
3119 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003120 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003121 << "stencil, the other one must have exactly the same format. "
3122 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3123 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003124 skip |=
3125 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3126 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003127 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003128 } // Depth or Stencil
3129
3130 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003131 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003132 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003133 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3134 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3135 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003136 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003137 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3138 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003139 for (uint32_t i = 0; i < regionCount; i++) {
3140 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003141 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003142 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003143 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3144 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003145 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003146 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3147 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003148 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3149 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3150 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003151 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003152 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003153 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003154 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003155 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3156 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003157 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003158 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3159 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003160 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003161 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3162 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003163 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003164 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003165 skip |=
3166 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3167 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003168 }
Dave Houlton48989f32017-05-26 15:01:46 -06003169 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3170 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003171 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003172 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003173 skip |=
3174 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3175 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003176 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003177
3178 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003179 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003180 skip |= log_msg(
3181 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3182 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3183 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003184 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003185
Dave Houlton48989f32017-05-26 15:01:46 -06003186 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003187 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003188 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003189 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003190 }
Dave Houlton48989f32017-05-26 15:01:46 -06003191
Dave Houlton33c2d252017-06-09 17:08:32 -06003192 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3193 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 -06003194 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003195 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003196 "image format %s.",
3197 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003198 }
3199
3200 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3201 skip |= log_msg(
3202 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003203 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003204 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3205 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003206 }
3207
Dave Houlton48989f32017-05-26 15:01:46 -06003208 // Validate source image offsets
3209 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003210 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003211 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003212 skip |=
3213 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3214 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3215 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3216 "of (%1d, %1d). These must be (0, 1).",
3217 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003218 }
3219 }
3220
Dave Houlton33c2d252017-06-09 17:08:32 -06003221 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003222 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3223 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 -06003224 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003225 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003226 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3227 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003228 }
3229 }
3230
Dave Houlton33c2d252017-06-09 17:08:32 -06003231 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003232 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3233 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003235 skip |= log_msg(
3236 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3237 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3238 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3239 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003240 }
3241 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3242 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003243 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003244 skip |= log_msg(
3245 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003246 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003247 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003248 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003249 }
3250 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3251 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003252 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003253 skip |= log_msg(
3254 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3255 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3256 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3257 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003258 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003259 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003260 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 -06003261 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003262 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003263 }
Dave Houlton48989f32017-05-26 15:01:46 -06003264
3265 // Validate dest image offsets
3266 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003267 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003268 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003269 skip |=
3270 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3271 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3272 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3273 "(%1d, %1d). These must be (0, 1).",
3274 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003275 }
3276 }
3277
Dave Houlton33c2d252017-06-09 17:08:32 -06003278 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003279 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3280 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 -06003281 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003282 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003283 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3284 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003285 }
3286 }
3287
Dave Houlton33c2d252017-06-09 17:08:32 -06003288 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003289 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3290 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003291 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003292 skip |= log_msg(
3293 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3294 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3295 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3296 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003297 }
3298 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3299 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003300 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003301 skip |= log_msg(
3302 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003303 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003304 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003305 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003306 }
3307 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3308 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003309 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003310 skip |= log_msg(
3311 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3312 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3313 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3314 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003315 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003316 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003317 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 -06003318 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003319 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003320 }
3321
Dave Houlton33c2d252017-06-09 17:08:32 -06003322 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3323 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3324 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003325 skip |=
3326 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3327 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3328 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3329 "layerCount other than 1.",
3330 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003331 }
3332 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003333 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003334 } else {
3335 assert(0);
3336 }
3337 return skip;
3338}
3339
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003340void ValidationStateTracker::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage,
3341 VkImageLayout srcImageLayout, VkImage dstImage, VkImageLayout dstImageLayout,
3342 uint32_t regionCount, const VkImageBlit *pRegions, VkFilter filter) {
3343 auto cb_node = GetCBState(commandBuffer);
3344 auto src_image_state = GetImageState(srcImage);
3345 auto dst_image_state = GetImageState(dstImage);
3346
3347 // Update bindings between images and cmd buffer
3348 AddCommandBufferBindingImage(cb_node, src_image_state);
3349 AddCommandBufferBindingImage(cb_node, dst_image_state);
3350}
3351
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003352void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3353 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3354 const VkImageBlit *pRegions, VkFilter filter) {
John Zulauf8f6d4ee2019-07-05 16:31:57 -06003355 StateTracker::PreCallRecordCmdBlitImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout, regionCount,
3356 pRegions, filter);
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003357 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003358 auto src_image_state = GetImageState(srcImage);
3359 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003360
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003361 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003362 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003363 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3364 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003365 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003366}
3367
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003368// 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 -06003369bool CoreChecks::ValidateCmdBufImageLayouts(const CMD_BUFFER_STATE *pCB, const ImageSubresPairLayoutMap &globalImageLayoutMap,
3370 ImageSubresPairLayoutMap *overlayLayoutMap_arg) const {
Matthew Ruschd7ef5482019-07-16 22:01:54 -07003371 if (disabled.image_layout_validation) return false;
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003372 bool skip = false;
John Zulauf3b04ebd2019-07-18 14:08:11 -06003373 ImageSubresPairLayoutMap &overlayLayoutMap = *overlayLayoutMap_arg;
John Zulauff660ad62019-03-23 07:16:05 -06003374 // Iterate over the layout maps for each referenced image
3375 for (const auto &layout_map_entry : pCB->image_layout_map) {
3376 const auto image = layout_map_entry.first;
3377 const auto *image_state = GetImageState(image);
3378 if (!image_state) continue; // Can't check layouts of a dead image
locke-lunargadbb54c2019-06-26 00:05:17 -06003379 auto subres_map = layout_map_entry.second.get();
John Zulauff660ad62019-03-23 07:16:05 -06003380 ImageSubresourcePair isr_pair;
3381 isr_pair.image = image;
3382 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003383
locke-lunargadbb54c2019-06-26 00:05:17 -06003384 std::string bind_swapchain_msg = "";
3385 if (image_state->bind_swapchain) {
3386 auto swapchain_node = GetSwapchainState(image_state->bind_swapchain);
3387 const auto swapchain_image = swapchain_node->images[image_state->bind_swapchain_imageIndex];
3388 isr_pair.image = swapchain_image;
3389
3390 string_sprintf(&bind_swapchain_msg, "bind %s imageIndex %d (%s)",
3391 report_data->FormatHandle(image_state->bind_swapchain).c_str(), image_state->bind_swapchain_imageIndex,
3392 report_data->FormatHandle(swapchain_image).c_str());
3393 }
3394
John Zulauff660ad62019-03-23 07:16:05 -06003395 // Validate the initial_uses for each subresource referenced
3396 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3397 isr_pair.subresource = (*it_init).subresource;
3398 VkImageLayout initial_layout = (*it_init).layout;
3399 VkImageLayout image_layout;
3400 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3401 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3402 // TODO: Set memory invalid which is in mem_tracker currently
3403 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003404 // Need to look up the inital layout *state* to get a bit more information
3405 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3406 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3407 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3408 if (!matches) {
3409 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
locke-lunargadbb54c2019-06-26 00:05:17 -06003410 skip |= log_msg(
3411 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3412 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3413 "Submitted command buffer expects %s %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
3414 "to be in layout %s--instead, current layout is %s.%s",
3415 report_data->FormatHandle(image).c_str(), bind_swapchain_msg.c_str(), isr_pair.subresource.aspectMask,
3416 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout),
3417 string_VkImageLayout(image_layout), formatted_label.c_str());
John Zulaufb61ed972019-04-09 16:12:35 -06003418 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003419 }
3420 }
John Zulauff660ad62019-03-23 07:16:05 -06003421 }
3422
3423 // Update all layout set operations (which will be a subset of the initial_layouts
3424 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3425 VkImageLayout layout = (*it_set).layout;
3426 isr_pair.subresource = (*it_set).subresource;
3427 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003428 }
3429 }
John Zulauff660ad62019-03-23 07:16:05 -06003430
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003431 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003432}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003433
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003434void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003435 for (const auto &layout_map_entry : pCB->image_layout_map) {
3436 const auto image = layout_map_entry.first;
3437 const auto *image_state = GetImageState(image);
3438 if (!image_state) continue; // Can't set layouts of a dead image
3439 const auto &subres_map = layout_map_entry.second;
3440 ImageSubresourcePair isr_pair;
3441 isr_pair.image = image;
3442 isr_pair.hasSubresource = true;
3443
3444 // Update all layout set operations (which will be a subset of the initial_layouts
3445 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3446 VkImageLayout layout = (*it_set).layout;
3447 isr_pair.subresource = (*it_set).subresource;
3448 SetGlobalLayout(isr_pair, layout);
3449 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003450 }
3451}
3452
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003453// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003454// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3455// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003456bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3457 const VkImageLayout first_layout, const uint32_t attachment,
John Zulauf9d2b6382019-07-25 15:21:36 -06003458 const VkAttachmentDescription2KHR &attachment_description) const {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003459 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003460 const char *vuid;
3461 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3462
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003463 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3464 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003465 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3466 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3467 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003468 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003469 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3470 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3471 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3472 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3473 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3474 skip |=
3475 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3476 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003477 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003478 }
3479 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003480 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3481 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003482 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003483 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003484 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 -06003485 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003486 }
3487 }
3488
3489 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3490 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003491 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003492 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003493 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 -06003494 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003495 }
3496 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003497 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003498}
3499
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003500bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
John Zulauf9d2b6382019-07-25 15:21:36 -06003501 const VkRenderPassCreateInfo2KHR *pCreateInfo) const {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003502 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003503 const char *vuid;
3504 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3505 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003506
Jason Ekstranda1906302017-12-03 20:16:32 -08003507 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3508 VkFormat format = pCreateInfo->pAttachments[i].format;
3509 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3510 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3511 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003512 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 -06003513 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003514 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3515 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3516 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3517 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003518 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003519 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003520 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 -06003521 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003522 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3523 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3524 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3525 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003526 }
3527 }
3528 }
3529
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003530 // Track when we're observing the first use of an attachment
3531 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3532 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003533 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003534
3535 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3536 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3537 auto attach_index = subpass.pInputAttachments[j].attachment;
3538 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003539 switch (subpass.pInputAttachments[j].layout) {
3540 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3541 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3542 // These are ideal.
3543 break;
3544
3545 case VK_IMAGE_LAYOUT_GENERAL:
3546 // May not be optimal. TODO: reconsider this warning based on other constraints.
3547 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003548 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003549 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3550 break;
3551
Tobias Hectorbbb12282018-10-22 15:17:59 +01003552 case VK_IMAGE_LAYOUT_UNDEFINED:
3553 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3554 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3555 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3556 "Layout for input attachment reference %u in subpass %u is %s but must be "
3557 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
Petr Kraus123ba9d2019-08-10 03:01:41 +02003558 j, i, string_VkImageLayout(subpass.pInputAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003559 break;
3560
Graeme Leese668a9862018-10-08 10:40:02 +01003561 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3562 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003563 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003564 break;
3565 } else {
3566 // Intentionally fall through to generic error message
3567 }
3568 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003569
Cort Stratton7547f772017-05-04 15:18:52 -07003570 default:
3571 // No other layouts are acceptable
3572 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 -06003573 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003574 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3575 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3576 }
3577
Cort Stratton7547f772017-05-04 15:18:52 -07003578 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003579 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3580 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003581
3582 bool used_as_depth =
3583 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3584 bool used_as_color = false;
3585 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3586 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3587 }
3588 if (!used_as_depth && !used_as_color &&
3589 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003590 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3591 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3592 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3593 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003594 }
3595 }
3596 attach_first_use[attach_index] = false;
3597 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003598
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003599 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3600 auto attach_index = subpass.pColorAttachments[j].attachment;
3601 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3602
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003603 // TODO: Need a way to validate shared presentable images here, currently just allowing
3604 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3605 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003606 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003607 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003608 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003609 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3610 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003611 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003612
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003613 case VK_IMAGE_LAYOUT_GENERAL:
3614 // May not be optimal; TODO: reconsider this warning based on other constraints?
3615 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003616 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003617 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3618 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003619
Tobias Hectorbbb12282018-10-22 15:17:59 +01003620 case VK_IMAGE_LAYOUT_UNDEFINED:
3621 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3622 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3623 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3624 "Layout for color attachment reference %u in subpass %u is %s but should be "
3625 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3626 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3627 break;
3628
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003629 default:
3630 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 -06003631 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003632 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3633 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003634 }
3635
John Zulauf4eee2692019-02-09 16:14:25 -07003636 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3637 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3638 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003639 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3640 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 -07003641 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003642 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003643 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003644 }
3645
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003646 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003647 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3648 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003649 }
3650 attach_first_use[attach_index] = false;
3651 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003652
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003653 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3654 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003655 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3656 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3657 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003658 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003659
Dave Houltona9df0ce2018-02-07 10:51:23 -07003660 case VK_IMAGE_LAYOUT_GENERAL:
3661 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3662 // doing a bunch of transitions.
3663 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003664 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003665 "GENERAL layout for depth attachment may not give optimal performance.");
3666 break;
3667
Tobias Hectorbbb12282018-10-22 15:17:59 +01003668 case VK_IMAGE_LAYOUT_UNDEFINED:
3669 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3670 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3671 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3672 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3673 "layout or GENERAL.",
3674 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3675 break;
3676
Dave Houltona9df0ce2018-02-07 10:51:23 -07003677 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3678 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003679 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003680 break;
3681 } else {
3682 // Intentionally fall through to generic error message
3683 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003684 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003685
Dave Houltona9df0ce2018-02-07 10:51:23 -07003686 default:
3687 // No other layouts are acceptable
3688 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 -06003689 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003690 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3691 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3692 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003693 }
3694
3695 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3696 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003697 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3698 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003699 }
3700 attach_first_use[attach_index] = false;
3701 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003702 }
3703 return skip;
3704}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003705
Mark Lobodzinski96210742017-02-09 10:33:46 -07003706// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3707// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06003708bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003709 const char *msgCode, char const *func_name, char const *usage_str) const {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003710 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003711 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003712 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003713 if (strict) {
3714 correct_usage = ((actual & desired) == desired);
3715 } else {
3716 correct_usage = ((actual & desired) != 0);
3717 }
3718 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003719 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003720 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06003721 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
3722 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
locke-lunarg9edc2812019-06-17 23:18:52 -06003723 "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3724 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003725 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06003726 skip =
3727 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 -06003728 msgCode, "Invalid usage flag for %s used by %s. In this case, %s should have %s set during creation.",
3729 report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003730 }
3731 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003732 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003733}
3734
3735// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3736// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003737bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003738 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003739 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
3740 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003741}
3742
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003743bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
John Zulauf07288512019-07-05 11:09:50 -06003744 char const *func_name, const char *linear_vuid, const char *optimal_vuid) const {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003745 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003746 bool skip = false;
3747 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3748 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003749 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3750 HandleToUint64(image_state->image), linear_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003751 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Lockee9aeebf2019-03-03 23:50:08 -07003752 format_properties.linearTilingFeatures, image_state->createInfo.format,
3753 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003754 }
3755 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3756 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3757 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3758 HandleToUint64(image_state->image), optimal_vuid,
locke-lunarg9edc2812019-06-17 23:18:52 -06003759 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003760 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003761 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003762 }
3763 }
3764 return skip;
3765}
3766
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003767bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
John Zulaufe2b7bcb2019-07-05 16:08:39 -06003768 char const *func_name, char const *member, uint32_t i) const {
Cort Strattond619a302018-05-17 19:46:32 -07003769 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003770 // layerCount must not be zero
3771 if (subresource_layers->layerCount == 0) {
3772 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3773 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3774 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3775 }
3776 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3777 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3778 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3779 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3780 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3781 }
3782 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3783 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3784 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3786 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3787 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3788 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3789 func_name, i, member);
3790 }
3791 return skip;
3792}
3793
Mark Lobodzinski96210742017-02-09 10:33:46 -07003794// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3795// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003796bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
John Zulauf005c5012019-07-10 17:15:47 -06003797 char const *func_name, char const *usage_string) const {
John Zulauf4fea6622019-04-01 11:38:18 -06003798 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
3799 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003800}
3801
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003802bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3803 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003804 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003805
3806 const VkDeviceSize &range = pCreateInfo->range;
3807 if (range != VK_WHOLE_SIZE) {
3808 // Range must be greater than 0
3809 if (range <= 0) {
3810 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3811 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3812 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3813 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3814 range);
3815 }
3816 // Range must be a multiple of the element size of format
Petr Kraus5a01b472019-08-10 01:40:28 +02003817 const uint32_t format_size = FormatElementSize(pCreateInfo->format);
3818 if (SafeModulo(range, format_size) != 0) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003819 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3820 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3821 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3822 ") 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 +02003823 "(%" PRIu32 ").",
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003824 range, format_size);
3825 }
3826 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
Petr Kraus5a01b472019-08-10 01:40:28 +02003827 if (SafeDivision(range, format_size) > device_limits->maxTexelBufferElements) {
3828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3829 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3830 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3831 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (%" PRIu32
3832 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3833 range, format_size, device_limits->maxTexelBufferElements);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003834 }
3835 // The sum of range and offset must be less than or equal to the size of buffer
3836 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3837 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3838 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3839 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3840 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3841 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3842 range, pCreateInfo->offset, buffer_state->createInfo.size);
3843 }
3844 }
3845 return skip;
3846}
3847
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003848bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003849 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003850 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003851 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3852 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3853 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3854 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3855 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3856 "be supported for uniform texel buffers");
3857 }
3858 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3859 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3860 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3861 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3862 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3863 "be supported for storage texel buffers");
3864 }
3865 return skip;
3866}
3867
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003868bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3869 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003870 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003871
Dave Houltond8ed0212018-05-16 17:18:24 -06003872 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003873
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003874 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003875 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 -06003876 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003877 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003878 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003879 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003880
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003881 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003882 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 -06003883 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003884 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003885 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003886 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003887
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003888 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003889 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 -06003890 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003891 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003892 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003893 }
Jeff Bolz87697532019-01-11 22:54:00 -06003894
3895 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3896 if (chained_devaddr_struct) {
3897 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3898 chained_devaddr_struct->deviceAddress != 0) {
3899 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3900 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3901 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3902 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3903 }
3904 }
3905
3906 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003907 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003908 skip |= log_msg(
3909 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3910 "VUID-VkBufferCreateInfo-flags-02605",
3911 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3912 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3913 }
3914
3915 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003916 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003917 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3918 "VUID-VkBufferCreateInfo-usage-02606",
3919 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3920 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3921 }
3922
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003923 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003924 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3925 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3926 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003927 }
3928
Mark Lobodzinski96210742017-02-09 10:33:46 -07003929 return skip;
3930}
3931
John Zulauf7eeb6f72019-06-17 11:56:36 -06003932void ValidationStateTracker::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3933 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer,
3934 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003935 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003936 // 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 -06003937 std::unique_ptr<BUFFER_STATE> buffer_state(new BUFFER_STATE(*pBuffer, pCreateInfo));
3938
3939 // Get a set of requirements in the case the app does not
3940 DispatchGetBufferMemoryRequirements(device, *pBuffer, &buffer_state->requirements);
3941
3942 bufferMap.insert(std::make_pair(*pBuffer, std::move(buffer_state)));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003943}
3944
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003945bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3946 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003947 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003948 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003949 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3950 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003951 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003952 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3953 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003954 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003955 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3956 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3957 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003958
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003959 // Buffer view offset must be less than the size of buffer
3960 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3961 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3962 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3963 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3964 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3965 pCreateInfo->offset, buffer_state->createInfo.size);
3966 }
3967
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003968 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Jeff Bolzd5554e62019-07-19 13:23:52 -05003969 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3970 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0 &&
3971 !enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
3972 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3973 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-02749",
3974 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3975 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3976 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3977 }
3978
3979 if (enabled_features.texel_buffer_alignment_features.texelBufferAlignment) {
3980 VkDeviceSize elementSize = FormatElementSize(pCreateInfo->format);
3981 if ((elementSize % 3) == 0) {
3982 elementSize /= 3;
3983 }
3984 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) {
3985 VkDeviceSize alignmentRequirement =
3986 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes;
3987 if (phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment) {
3988 alignmentRequirement = std::min(alignmentRequirement, elementSize);
3989 }
3990 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
3991 skip |= log_msg(
3992 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3993 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02750",
3994 "If buffer was created with usage containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, "
3995 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3996 ") must be a multiple of the lesser of "
3997 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
3998 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment "
3999 "(%" PRId32
4000 ") is VK_TRUE, the size of a texel of the requested format. "
4001 "If the size of a texel is a multiple of three bytes, then the size of a "
4002 "single component of format is used instead",
4003 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetAlignmentBytes,
4004 phys_dev_ext_props.texel_buffer_alignment_props.storageTexelBufferOffsetSingleTexelAlignment);
4005 }
4006 }
4007 if (buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) {
4008 VkDeviceSize alignmentRequirement =
4009 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes;
4010 if (phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment) {
4011 alignmentRequirement = std::min(alignmentRequirement, elementSize);
4012 }
4013 if (SafeModulo(pCreateInfo->offset, alignmentRequirement) != 0) {
4014 skip |= log_msg(
4015 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
4016 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-02751",
4017 "If buffer was created with usage containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, "
4018 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
4019 ") must be a multiple of the lesser of "
4020 "VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes (%" PRIuLEAST64
4021 ") or, if VkPhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment "
4022 "(%" PRId32
4023 ") is VK_TRUE, the size of a texel of the requested format. "
4024 "If the size of a texel is a multiple of three bytes, then the size of a "
4025 "single component of format is used instead",
4026 pCreateInfo->offset, phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetAlignmentBytes,
4027 phys_dev_ext_props.texel_buffer_alignment_props.uniformTexelBufferOffsetSingleTexelAlignment);
4028 }
4029 }
4030 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06004031
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004032 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06004033
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004034 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07004035 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07004036 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07004037}
4038
John Zulauf7eeb6f72019-06-17 11:56:36 -06004039void ValidationStateTracker::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
4040 const VkAllocationCallbacks *pAllocator, VkBufferView *pView,
4041 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004042 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004043 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07004044}
Mark Lobodzinski602de982017-02-09 11:01:33 -07004045
4046// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004047bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
John Zulauf9d2b6382019-07-25 15:21:36 -06004048 const char *vuid) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004049 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01004050 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
4051 if (image != VK_NULL_HANDLE) {
4052 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
4053 }
4054
Dave Houlton1d2022c2017-03-29 11:43:58 -06004055 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004056 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004057 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004058 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004059 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004060 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004061 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004062 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004063 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004064 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004065 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004066 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004067 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4068 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004069 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004070 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004071 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004072 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4073 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004074 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004075 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004076 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004077 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004078 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004079 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004080 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004081 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004082 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004083 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004084 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004085 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004086 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004087 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004088 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004089 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004090 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004091 } else if (FormatIsMultiplane(format)) {
4092 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4093 if (3 == FormatPlaneCount(format)) {
4094 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4095 }
4096 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004097 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004098 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4099 "set, where n = [0, 1, 2].",
4100 func_name);
4101 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004102 }
4103 return skip;
4104}
4105
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004106bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
4107 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4108 const char *param_name, const char *image_layer_count_var_name,
John Zulauf07288512019-07-05 11:09:50 -06004109 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) const {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004110 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004111
4112 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004113 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004114 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 -06004115 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004116 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004117 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4118 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004119 }
Petr Kraus4d718682017-05-18 03:38:41 +02004120
Petr Krausffa94af2017-08-08 21:46:02 +02004121 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4122 if (subresourceRange.levelCount == 0) {
4123 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 -06004124 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004125 } else {
4126 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004127
Petr Krausffa94af2017-08-08 21:46:02 +02004128 if (necessary_mip_count > image_mip_count) {
4129 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 -06004130 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004131 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004132 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004133 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004134 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004135 }
Petr Kraus4d718682017-05-18 03:38:41 +02004136 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004137 }
Petr Kraus4d718682017-05-18 03:38:41 +02004138
4139 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004140 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004141 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 -06004142 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004143 "%s: %s.baseArrayLayer (= %" PRIu32
4144 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4145 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004146 }
Petr Kraus4d718682017-05-18 03:38:41 +02004147
Petr Krausffa94af2017-08-08 21:46:02 +02004148 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4149 if (subresourceRange.layerCount == 0) {
4150 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 -06004151 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004152 } else {
4153 const uint64_t necessary_layer_count =
4154 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004155
Petr Krausffa94af2017-08-08 21:46:02 +02004156 if (necessary_layer_count > image_layer_count) {
4157 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 -06004158 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004159 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004160 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004161 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004162 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004163 }
Petr Kraus4d718682017-05-18 03:38:41 +02004164 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004165 }
Petr Kraus4d718682017-05-18 03:38:41 +02004166
Mark Lobodzinski602de982017-02-09 11:01:33 -07004167 return skip;
4168}
4169
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004170bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004171 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004172 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004173 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4174 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4175 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4176
4177 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4178 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4179
4180 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004181 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4182 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004183 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004184 : "VUID-VkImageViewCreateInfo-image-01482")
4185 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4186 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004187 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004188 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4189 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004190
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004191 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004192 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4193 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4194}
4195
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004196bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
John Zulauf07288512019-07-05 11:09:50 -06004197 const VkImageSubresourceRange &subresourceRange,
4198 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004199 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004200 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4201 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4202 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4203 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004204
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004205 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4206 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4207 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004208}
4209
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004210bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
John Zulaufeabb4462019-07-05 14:13:03 -06004211 const VkImageSubresourceRange &subresourceRange,
4212 const char *param_name) const {
Petr Krausffa94af2017-08-08 21:46:02 +02004213 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004214 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4215 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4216 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4217 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004218
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004219 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4220 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004221 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4222}
4223
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004224bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004225 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4226 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004227 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004228 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4229 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4230 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4231 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004232
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004233 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4234 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004235 subresourceRangeErrorCodes);
4236}
4237
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004238bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4239 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004240 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004241 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004242 if (image_state) {
4243 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004244 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004245 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004246 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4247 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004248 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004249 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004250 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004251 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004252 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004253 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004254 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004255 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004256
4257 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4258 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004259 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4260 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004261 VkFormat view_format = pCreateInfo->format;
4262 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004263 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004264 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004265
Dave Houltonbd2e2622018-04-10 16:41:14 -06004266 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004267 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004268 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004269 image_usage = chained_ivuci_struct->usage;
4270 }
4271
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004272 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4273 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004274 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004275 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004276 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004277 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004278 std::stringstream ss;
4279 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004280 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004281 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004282 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 -07004283 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004284 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004285 }
4286 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004287 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004288 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4289 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4290 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4291 std::stringstream ss;
4292 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
locke-lunarg9edc2812019-06-17 23:18:52 -06004293 << " is not in the same format compatibility class as "
4294 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004295 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4296 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004297 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004298 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004299 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004300 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004301 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004302 }
4303 } else {
4304 // Format MUST be IDENTICAL to the format the image was created with
4305 if (image_format != view_format) {
4306 std::stringstream ss;
locke-lunarg9edc2812019-06-17 23:18:52 -06004307 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from "
Lockee9aeebf2019-03-03 23:50:08 -07004308 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004309 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004310 skip |=
4311 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004312 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004313 }
4314 }
4315
4316 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004317 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004318
4319 switch (image_type) {
4320 case VK_IMAGE_TYPE_1D:
4321 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004322 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 -07004323 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004324 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4325 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004326 }
4327 break;
4328 case VK_IMAGE_TYPE_2D:
4329 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4330 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4331 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004332 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 -07004333 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004334 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4335 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004336 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004338 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004339 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4340 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004341 }
4342 }
4343 break;
4344 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004345 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004346 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4347 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4348 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004349 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004350 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004351 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004352 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4353 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004354 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4355 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004356 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004357 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004358 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004359 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4360 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004361 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4362 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004363 }
4364 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004365 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 -07004366 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004367 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4368 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004369 }
4370 }
4371 } else {
4372 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004373 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 -07004374 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004375 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4376 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004377 }
4378 }
4379 break;
4380 default:
4381 break;
4382 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004383
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004384 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004385 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004386 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004387 }
4388
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004389 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004390 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4391 : format_properties.optimalTilingFeatures;
4392
4393 if (tiling_features == 0) {
4394 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 -07004395 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004396 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4397 "physical device.",
4398 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4399 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4400 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-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004402 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4403 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4404 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4405 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4406 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 -07004407 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004408 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4409 "VK_IMAGE_USAGE_STORAGE_BIT.",
4410 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4411 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4412 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4413 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 -07004414 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004415 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4416 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4417 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4418 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4419 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4420 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 -07004421 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004422 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4423 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4424 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004425 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004426
Jeff Bolz9af91c52018-09-01 21:53:57 -05004427 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4428 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4429 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 -07004430 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004431 "vkCreateImageView() If image was created with usage containing "
4432 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4433 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4434 }
4435 if (view_format != VK_FORMAT_R8_UINT) {
4436 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 -07004437 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004438 "vkCreateImageView() If image was created with usage containing "
4439 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4440 }
4441 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004442 }
4443 return skip;
4444}
4445
John Zulauf7eeb6f72019-06-17 11:56:36 -06004446void ValidationStateTracker::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4447 const VkAllocationCallbacks *pAllocator, VkImageView *pView,
4448 VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004449 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004450 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004451 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004452}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004453
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004454bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4455 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004456 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004457 auto src_buffer_state = GetBufferState(srcBuffer);
4458 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004459
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004460 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004461 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4462 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004463 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004464 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004465 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4466 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004467 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004468 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4469 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004470 skip |=
4471 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4472 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004473 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4474 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004475 return skip;
4476}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004477
John Zulauf1686f232019-07-09 16:27:11 -06004478void ValidationStateTracker::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4479 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004480 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004481 auto src_buffer_state = GetBufferState(srcBuffer);
4482 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004483
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004484 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004485 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4486 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004487}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004488
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004489bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004490 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004491 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004492 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004493 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 -06004494 kVUID_Core_DrawState_DoubleDestroy, "Cannot free %s that has not been allocated.",
Lockee9aeebf2019-03-03 23:50:08 -07004495 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004496 } else {
4497 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004498 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 -06004499 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
locke-lunarg9edc2812019-06-17 23:18:52 -06004500 "Cannot free %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004501 }
4502 }
4503 return skip;
4504}
4505
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004506bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004507 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004508 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004509
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004510 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004511 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004512 skip |=
4513 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004514 }
4515 return skip;
4516}
4517
John Zulauf7eeb6f72019-06-17 11:56:36 -06004518void ValidationStateTracker::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView,
4519 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004520 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004521 if (!image_view_state) return;
John Zulauf4fea6622019-04-01 11:38:18 -06004522 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004523
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004524 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004525 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004526 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004527}
4528
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004529bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004530 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004531
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004532 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004533 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004534 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004535 }
4536 return skip;
4537}
4538
John Zulauf7eeb6f72019-06-17 11:56:36 -06004539void ValidationStateTracker::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004540 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004541 auto buffer_state = GetBufferState(buffer);
John Zulauf4fea6622019-04-01 11:38:18 -06004542 const VulkanTypedHandle obj_struct(buffer, kVulkanObjectTypeBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004543
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004544 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004545 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06004546 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004547 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004548 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004549 }
4550 }
John Zulauf4fea6622019-04-01 11:38:18 -06004551 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004552 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004553}
4554
John Zulauf7eeb6f72019-06-17 11:56:36 -06004555void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
4556 if (!buffer) return;
4557
4558 // Clean up validation specific data
4559 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
4560
4561 // Clean up generic buffer state
4562 StateTracker::PreCallRecordDestroyBuffer(device, buffer, pAllocator);
4563}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004564bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4565 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004566 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004567 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004568 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004569 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004570 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004571 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004572 }
4573 return skip;
4574}
4575
John Zulauf7eeb6f72019-06-17 11:56:36 -06004576void ValidationStateTracker::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView,
4577 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004578 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004579 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004580 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004581
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004582 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004583 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004584 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004585}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004586
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004587bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4588 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004589 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004590 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004591 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004592 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004593 skip |=
4594 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4595 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004596 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004597 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004598 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4599 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004600 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004601 return skip;
4602}
4603
John Zulauf1686f232019-07-09 16:27:11 -06004604void ValidationStateTracker::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4605 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004606 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004607 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004608 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004609 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004610}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004611
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004612bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4613 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004614 bool skip = false;
4615
4616 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004617 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4618 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004619 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 -06004620 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004621 "%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 -06004622 "and 1, respectively.",
4623 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004624 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004625 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004626
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004627 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4628 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004629 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 -06004630 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004631 "%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 -06004632 "must be 0 and 1, respectively.",
4633 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004634 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004635 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004636
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004637 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4638 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004639 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 -06004640 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004641 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4642 "For 3D images these must be 0 and 1, respectively.",
4643 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004644 }
4645 }
4646
4647 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004648 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004649 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4650
Dave Houltona585d132019-01-18 13:05:42 -07004651 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004652 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 -06004653 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004654 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004655 " must be a multiple of this format's texel size (%" PRIu32 ").",
4656 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004657 }
4658
4659 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004660 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004661 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 -06004662 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004663 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4664 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004665 }
4666
4667 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4668 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004669 skip |=
4670 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004671 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004672 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4673 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004674 }
4675
4676 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4677 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4678 skip |= log_msg(
4679 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004680 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004681 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4682 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004683 }
4684
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004685 // Calculate adjusted image extent, accounting for multiplane image factors
4686 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4687 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4688 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4689 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
4690 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4691 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
4692 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4693 "zero or <= image subresource width (%d).",
4694 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4695 adusted_image_extent.width);
4696 }
4697
4698 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4699 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4700 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
4701 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4702 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
4703 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4704 "zero or <= image subresource height (%d).",
4705 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4706 adusted_image_extent.height);
4707 }
4708
4709 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4710 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4711 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
4712 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4713 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
4714 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4715 "zero or <= image subresource depth (%d).",
4716 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4717 adusted_image_extent.depth);
4718 }
4719
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004720 // subresource aspectMask must have exactly 1 bit set
4721 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4722 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4723 if (aspect_mask_bits.count() != 1) {
4724 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 -06004725 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004726 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004727 }
4728
4729 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004730 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004731 skip |= log_msg(
4732 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004733 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004734 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4735 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004736 }
4737
4738 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004739 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004740 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004741
4742 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004743 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004744 skip |= log_msg(
4745 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004746 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004747 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4748 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004749 }
4750
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004751 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004752 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004753 skip |= log_msg(
4754 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004755 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004756 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4757 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004758 }
4759
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004760 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004761 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4762 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4763 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004764 skip |=
4765 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004766 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004767 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4768 "width & height (%d, %d)..",
4769 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004770 }
4771
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004772 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004773 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004774 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004775 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 -06004776 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004777 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004778 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004779 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004780 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004781
4782 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004783 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004784 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004785 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4786 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004787 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004788 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004789 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004790 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004791 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004792 }
4793
4794 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004795 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004796 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4797 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004798 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004799 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004800 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004801 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004802 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004803 }
4804
4805 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004806 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004807 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4808 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004809 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004810 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004811 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004812 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004813 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004814 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004815 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004816 }
4817
4818 return skip;
4819}
4820
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004821static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004822 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004823 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004824 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004825
4826 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004827 VkExtent3D extent = pRegions[i].imageExtent;
4828 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004829
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004830 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4831 {
Dave Houlton51653902018-06-22 17:32:13 -06004832 skip |=
4833 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4834 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4835 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004836 }
4837
4838 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4839
4840 // 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 -06004841 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004842 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004843 if (image_extent.width % block_extent.width) {
4844 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4845 }
4846 if (image_extent.height % block_extent.height) {
4847 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4848 }
4849 if (image_extent.depth % block_extent.depth) {
4850 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4851 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004852 }
4853
Dave Houltonfc1a4052017-04-27 14:32:45 -06004854 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004855 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 -06004856 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004857 }
4858 }
4859
4860 return skip;
4861}
4862
Chris Forbese8ba09a2017-06-01 17:39:02 -07004863static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004864 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004865 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004866 bool skip = false;
4867
4868 VkDeviceSize buffer_size = buff_state->createInfo.size;
4869
4870 for (uint32_t i = 0; i < regionCount; i++) {
4871 VkExtent3D copy_extent = pRegions[i].imageExtent;
4872
4873 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4874 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004875 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4876 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004877
Tom Cooperb2550c72018-10-15 13:08:41 +01004878 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004879 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004880 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004881 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4882 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4883
4884 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4885 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4886 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004887 }
4888
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004889 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4890 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4891 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004892 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004893 } else {
4894 // Calculate buffer offset of final copied byte, + 1.
4895 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4896 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4897 max_buffer_offset *= unit_size; // convert to bytes
4898 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004899
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004900 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004901 skip |=
4902 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4903 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004904 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004905 }
4906 }
4907
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004908 return skip;
4909}
4910
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004911bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4912 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004913 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004914 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004915 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004916
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004917 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004918
4919 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004920 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004921
4922 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06004923 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004924
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004925 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004926
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004927 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4928 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 -06004929 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004930 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004931 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004932 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004933 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004934 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004935 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004936 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004937
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004938 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004939 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004940 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4941 skip |=
4942 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004943
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004944 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004945 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004946 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4947 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004948 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004949 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4950 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004951 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004952 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4953 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004954 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004955 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004956 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004957 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004958 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4959 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4960 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004961 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004962 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004963 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004964 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004965 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4966 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004967 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4968 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4969 skip |=
4970 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4971 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4972 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004973 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4974 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004975 }
4976 return skip;
4977}
4978
John Zulauf1686f232019-07-09 16:27:11 -06004979void ValidationStateTracker::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage,
4980 VkImageLayout srcImageLayout, VkBuffer dstBuffer,
4981 uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004982 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004983 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004984 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004985
John Zulauf1686f232019-07-09 16:27:11 -06004986 // Update bindings between buffer/image and cmd buffer
4987 AddCommandBufferBindingImage(cb_node, src_image_state);
4988 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
4989}
4990void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4991 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
4992 StateTracker::PreCallRecordCmdCopyImageToBuffer(commandBuffer, srcImage, srcImageLayout, dstBuffer, regionCount, pRegions);
4993
4994 auto cb_node = GetCBState(commandBuffer);
4995 auto src_image_state = GetImageState(srcImage);
John Zulauff660ad62019-03-23 07:16:05 -06004996 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004997 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004998 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004999 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005000}
5001
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005002bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5003 VkImageLayout dstImageLayout, uint32_t regionCount,
5004 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005005 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005006 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005007 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005008
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005009 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005010
5011 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005012 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005013
5014 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06005015 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005016 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005017 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
5018 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06005019 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005020 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005021 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07005022 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07005023 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005024 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07005025 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06005026 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005027 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06005028 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07005029 skip |=
5030 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
5031 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005032 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005033 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
5034 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005035 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06005036 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5037 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06005038 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005039 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
5040 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005041 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005042 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07005043 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005044 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005045 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
5046 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5047 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005048 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005049 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07005050 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005051 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005052 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5053 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07005054 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
5055 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
5056 skip |=
5057 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
5058 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5059 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07005060 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5061 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005062 }
5063 return skip;
5064}
5065
John Zulauf1686f232019-07-09 16:27:11 -06005066void ValidationStateTracker::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5067 VkImageLayout dstImageLayout, uint32_t regionCount,
5068 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06005069 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005070 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005071 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005072
John Zulauf1686f232019-07-09 16:27:11 -06005073 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
5074 AddCommandBufferBindingImage(cb_node, dst_image_state);
5075}
5076
5077void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5078 VkImageLayout dstImageLayout, uint32_t regionCount,
5079 const VkBufferImageCopy *pRegions) {
5080 StateTracker::PreCallRecordCmdCopyBufferToImage(commandBuffer, srcBuffer, dstImage, dstImageLayout, regionCount, pRegions);
5081
5082 auto cb_node = GetCBState(commandBuffer);
5083 auto dst_image_state = GetImageState(dstImage);
John Zulauff660ad62019-03-23 07:16:05 -06005084 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005085 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06005086 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005087 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005088}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005089
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005090bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5091 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005092 bool skip = false;
5093 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5094
Dave Houlton1d960ff2018-01-19 12:17:05 -07005095 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005096 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5097 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5098 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005099 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 -06005100 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005101 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005102 }
5103
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005104 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005105 if (!image_entry) {
5106 return skip;
5107 }
5108
Dave Houlton1d960ff2018-01-19 12:17:05 -07005109 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005110 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005111 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5112 "VUID-vkGetImageSubresourceLayout-image-00996",
5113 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005114 }
5115
Dave Houlton1d960ff2018-01-19 12:17:05 -07005116 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005117 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005118 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5119 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5120 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5121 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005122 }
5123
Dave Houlton1d960ff2018-01-19 12:17:05 -07005124 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005125 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005126 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5127 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5128 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5129 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005130 }
5131
Dave Houlton1d960ff2018-01-19 12:17:05 -07005132 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005133 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005134 if (FormatIsMultiplane(img_format)) {
5135 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005136 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005137 if (FormatPlaneCount(img_format) > 2u) {
5138 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005139 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005140 }
5141 if (sub_aspect != (sub_aspect & allowed_flags)) {
5142 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06005143 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005144 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005145 ") must be a single-plane specifier flag.",
5146 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005147 }
5148 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005149 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005150 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005151 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005152 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005153 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005154 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005155 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005156 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005157 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 -06005158 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005159 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005160 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005161 }
5162 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005163
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005164 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005165 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005166 }
5167
Mike Weiblen672b58b2017-02-21 14:32:53 -07005168 return skip;
5169}