blob: ba82c0aa95fcfbddac72ebd536a79dd2a3b3c095 [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"
32#include "vk_layer_data.h"
33#include "vk_layer_utils.h"
34#include "vk_layer_logging.h"
Dave Houltonbd2e2622018-04-10 16:41:14 -060035#include "vk_typemap_helper.h"
Mark Lobodzinski90224de2017-01-26 15:23:11 -070036
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070037#include "chassis.h"
Mark Lobodzinski76d76662019-02-14 14:38:21 -070038#include "core_validation.h"
39#include "shader_validation.h"
40#include "descriptor_sets.h"
Mark Lobodzinskid42e4d22017-01-17 14:14:22 -070041#include "buffer_validation.h"
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -070042
John Zulauff660ad62019-03-23 07:16:05 -060043// Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
44static VkImageSubresourceRange RangeFromLayers(const VkImageSubresourceLayers &subresource_layers) {
45 VkImageSubresourceRange subresource_range;
46 subresource_range.aspectMask = subresource_layers.aspectMask;
47 subresource_range.baseArrayLayer = subresource_layers.baseArrayLayer;
48 subresource_range.layerCount = subresource_layers.layerCount;
49 subresource_range.baseMipLevel = subresource_layers.mipLevel;
50 subresource_range.levelCount = 1;
51 return subresource_range;
52}
53
54IMAGE_STATE::IMAGE_STATE(VkImage img, const VkImageCreateInfo *pCreateInfo)
55 : image(img),
56 createInfo(*pCreateInfo),
57 valid(false),
58 acquired(false),
59 shared_presentable(false),
60 layout_locked(false),
61 get_sparse_reqs_called(false),
62 sparse_metadata_required(false),
63 sparse_metadata_bound(false),
64 imported_ahb(false),
65 has_ahb_format(false),
66 ahb_format(0),
67 full_range{},
68 sparse_requirements{} {
69 if ((createInfo.sharingMode == VK_SHARING_MODE_CONCURRENT) && (createInfo.queueFamilyIndexCount > 0)) {
70 uint32_t *pQueueFamilyIndices = new uint32_t[createInfo.queueFamilyIndexCount];
71 for (uint32_t i = 0; i < createInfo.queueFamilyIndexCount; i++) {
72 pQueueFamilyIndices[i] = pCreateInfo->pQueueFamilyIndices[i];
73 }
74 createInfo.pQueueFamilyIndices = pQueueFamilyIndices;
75 }
76
77 if (createInfo.flags & VK_IMAGE_CREATE_SPARSE_BINDING_BIT) {
78 sparse = true;
79 }
80 const auto format = createInfo.format;
81 VkImageSubresourceRange init_range{0, 0, VK_REMAINING_MIP_LEVELS, 0, VK_REMAINING_ARRAY_LAYERS};
82 if (FormatIsColor(format) || FormatIsMultiplane(format)) {
83 init_range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT; // Normalization will expand this for multiplane
84 } else {
85 init_range.aspectMask =
86 (FormatHasDepth(format) ? VK_IMAGE_ASPECT_DEPTH_BIT : 0) | (FormatHasStencil(format) ? VK_IMAGE_ASPECT_STENCIL_BIT : 0);
87 }
88 full_range = NormalizeSubresourceRange(*this, init_range);
Locked8af3732019-05-10 09:47:56 -060089
90#ifdef VK_USE_PLATFORM_ANDROID_KHR
91 auto external_format = lvl_find_in_chain<VkExternalFormatANDROID>(createInfo.pNext);
92 if (external_format) {
93 external_format_android = external_format->externalFormat;
94 } else {
95 // If externalFormat is zero, the effect is as if the VkExternalFormatANDROID structure was not present.
96 external_format_android = 0;
97 }
98#endif // VK_USE_PLATFORM_ANDROID_KHR
John Zulauff660ad62019-03-23 07:16:05 -060099}
100
101IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
102 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
103 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
104 if (conversionInfo) samplerConversion = conversionInfo->conversion;
105 if (image_state) {
106 // A light normalization of the createInfo range
107 auto &sub_res_range = create_info.subresourceRange;
108 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
109 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
110
111 // Cache a full normalization (for "full image/whole image" comparisons)
112 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
113 }
114}
115
Dave Houltond9611312018-11-19 17:03:36 -0700116uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
117 // uint cast applies floor()
118 return 1u + (uint32_t)log2(std::max({height, width, depth}));
119}
120
121uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
122
123uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
124
John Zulauff660ad62019-03-23 07:16:05 -0600125VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
126 const VkImageCreateInfo &image_create_info = image_state.createInfo;
127 VkImageSubresourceRange norm = range;
128 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
129
130 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
131 // <arrayLayers> can potentially alias.
132 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
133 ? image_create_info.extent.depth
134 : image_create_info.arrayLayers;
135 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
136
137 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
138 VkImageAspectFlags &aspect_mask = norm.aspectMask;
139 if (FormatIsMultiplane(image_create_info.format)) {
140 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
141 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
142 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
143 if (FormatPlaneCount(image_create_info.format) > 2) {
144 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
145 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700146 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700147 }
John Zulauff660ad62019-03-23 07:16:05 -0600148 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700149}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700150
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700151template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700152void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700153 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700154 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
155 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
156 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
157 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600158 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700159 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
160 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
161 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700162 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700163}
164
165template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700166void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700167 if (imgpair.subresource.aspectMask & aspectMask) {
168 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700169 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700170 }
171}
172
Tony Barbourdf013b92017-01-25 12:53:48 -0700173// Set the layout in supplied map
Mark Lobodzinskidb7a9fc2019-04-25 11:56:26 -0600174void CoreChecks::SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_STATE> &imageLayoutMap,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700175 ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700176 auto it = imageLayoutMap.find(imgpair);
177 if (it != imageLayoutMap.end()) {
178 it->second.layout = layout; // Update
179 } else {
180 imageLayoutMap[imgpair].layout = layout; // Insert
181 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700182}
183
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700184bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700185 if (!(imgpair.subresource.aspectMask & aspectMask)) {
186 return false;
187 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700188 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
189 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600190 auto imgsubIt = imageLayoutMap.find(imgpair);
191 if (imgsubIt == imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700192 return false;
193 }
194 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200195 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 -0600196 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700197 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
198 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700199 string_VkImageLayout(imgsubIt->second.layout));
200 }
201 layout = imgsubIt->second.layout;
202 return true;
203}
204
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700205// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700206bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700208 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
209 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
210 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
211 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600212 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700213 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
214 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
215 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700216 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700217 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
218 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600219 auto imgsubIt = imageLayoutMap.find(imgpair);
220 if (imgsubIt == imageLayoutMap.end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700221 layout = imgsubIt->second.layout;
222 }
223 return true;
224}
225
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700226bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600227 auto sub_data = imageSubresourceMap.find(image);
228 if (sub_data == imageSubresourceMap.end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700229 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700230 if (!image_state) return false;
231 bool ignoreGlobal = false;
232 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
233 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
234 ignoreGlobal = true;
235 }
236 for (auto imgsubpair : sub_data->second) {
237 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600238 auto img_data = imageLayoutMap.find(imgsubpair);
239 if (img_data != imageLayoutMap.end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700240 layouts.push_back(img_data->second.layout);
241 }
242 }
243 return true;
244}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700245
Mark Lobodzinskidb7a9fc2019-04-25 11:56:26 -0600246bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_STATE> &imageLayoutMap,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700247 ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700248 if (!(imgpair.subresource.aspectMask & aspectMask)) {
249 return false;
250 }
251 imgpair.subresource.aspectMask = aspectMask;
252 auto imgsubIt = imageLayoutMap.find(imgpair);
253 if (imgsubIt == imageLayoutMap.end()) {
254 return false;
255 }
256 layout = imgsubIt->second.layout;
257 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700258}
Tony Barbourdf013b92017-01-25 12:53:48 -0700259
260// find layout in supplied map
Mark Lobodzinskidb7a9fc2019-04-25 11:56:26 -0600261bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_STATE> &imageLayoutMap,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700262 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700263 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
264 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
265 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
266 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
267 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600268 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700269 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
270 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
271 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
272 }
273 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700274 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
275 imgpair = {imgpair.image, false, VkImageSubresource()};
276 auto imgsubIt = imageLayoutMap.find(imgpair);
277 if (imgsubIt == imageLayoutMap.end()) return false;
278 layout = imgsubIt->second.layout;
279 }
280 return true;
281}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700282
283// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700284void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700285 VkImage &image = imgpair.image;
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600286 auto data = imageLayoutMap.find(imgpair);
287 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700288 data->second.layout = layout; // Update
289 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600290 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700291 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600292 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700293 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
294 if (subresource == image_subresources.end()) {
295 image_subresources.push_back(imgpair);
296 }
297}
298
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600299// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600300void CoreChecks::SetImageLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600301 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
302 VkImageLayout expected_layout) {
303 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
304 assert(subresource_map); // the non-const getter must return a valid pointer
John Zulauf4ec24ec2019-05-02 17:22:59 -0600305 if (subresource_map->SetSubresourceRangeLayout(*cb_node, image_subresource_range, layout, expected_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600306 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700307 }
308}
John Zulauff660ad62019-03-23 07:16:05 -0600309
310// Set the initial image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600311void CoreChecks::SetImageViewInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600312 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
313 if (image_state) {
314 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600315 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, view_state.normalized_subresource_range, layout, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600316 }
317}
318
319// Set the initial image layout for a passed non-normalized subresource range
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600320void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600321 const VkImageSubresourceRange &range, VkImageLayout layout) {
322 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
323 assert(subresource_map);
John Zulauf4ec24ec2019-05-02 17:22:59 -0600324 subresource_map->SetSubresourceRangeInitialLayout(*cb_node, NormalizeSubresourceRange(image_state, range), layout);
John Zulauff660ad62019-03-23 07:16:05 -0600325}
326
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600327void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, VkImage image, const VkImageSubresourceRange &range,
John Zulauff660ad62019-03-23 07:16:05 -0600328 VkImageLayout layout) {
329 const IMAGE_STATE *image_state = GetImageState(image);
330 if (!image_state) return;
331 SetImageInitialLayout(cb_node, *image_state, range, layout);
332};
333
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600334void CoreChecks::SetImageInitialLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_STATE &image_state,
John Zulauff660ad62019-03-23 07:16:05 -0600335 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
336 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600337}
Dave Houltonddd65c52018-05-08 14:58:01 -0600338
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600339// Set image layout for all slices of an image view
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600340void CoreChecks::SetImageViewLayout(CMD_BUFFER_STATE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
John Zulauff660ad62019-03-23 07:16:05 -0600341 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
342 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600343
John Zulauff660ad62019-03-23 07:16:05 -0600344 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600345 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
346 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600347 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 -0600348 sub_range.baseArrayLayer = 0;
349 sub_range.layerCount = image_state->createInfo.extent.depth;
350 }
351
John Zulauff660ad62019-03-23 07:16:05 -0600352 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600353}
354
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700355bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
356 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700357 VkFramebuffer framebuffer, VkRenderPass renderpass,
358 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100359 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700360 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 const char *vuid;
362 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
363
364 if (!image_state) {
365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
366 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700367 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
368 "] = image view %s, which refers to an invalid image",
369 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
370 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100371 return skip;
372 }
373
374 auto image_usage = image_state->createInfo.usage;
375
376 // Check for layouts that mismatch image usages in the framebuffer
377 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
378 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
379 skip |=
380 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700381 "Layout/usage mismatch for attachment %u in render pass %s"
382 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600384 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
385 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 }
387
388 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
389 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
390 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
391 skip |=
392 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700393 "Layout/usage mismatch for attachment %u in render pass %s"
394 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100395 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600396 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
397 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 }
399
400 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
401 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
402 skip |=
403 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700404 "Layout/usage mismatch for attachment %u in render pass %s"
405 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100406 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600407 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
408 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100409 }
410
411 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
412 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
413 skip |=
414 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700415 "Layout/usage mismatch for attachment %u in render pass %s"
416 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100417 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600418 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
419 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420 }
421
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600422 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
424 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
425 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
426 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
427 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
428 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700429 skip |= log_msg(
430 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
431 "Layout/usage mismatch for attachment %u in render pass %s"
432 " - the %s is %s but the image attached to framebuffer %s via image view %s"
433 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600434 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
435 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 }
437 } else {
438 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
439 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
440 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
441 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
443 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700444 "Layout/usage mismatch for attachment %u in render pass %s"
445 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100446 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600447 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
448 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700449 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 }
451 }
452 return skip;
453}
454
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600455bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, CMD_BUFFER_STATE *pCB,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700456 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700457 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600458 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700459 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100461
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700462 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100463 auto framebuffer = framebuffer_state->framebuffer;
464
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700465 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600466 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 -0600467 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700468 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700469 }
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600470 const auto *const_pCB = static_cast<const CMD_BUFFER_STATE *>(pCB);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700471 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
472 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700473 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600474
475 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700476 skip |=
477 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
478 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
479 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
480 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
481 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600482 continue;
483 }
484
John Zulauff660ad62019-03-23 07:16:05 -0600485 const VkImage image = view_state->create_info.image;
486 const IMAGE_STATE *image_state = GetImageState(image);
487
488 if (!image_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(): framebuffer %s pAttachments[%" PRIu32
492 "] = VkImageView %s references non-extant VkImage %s.",
493 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
494 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
495 continue;
496 }
497 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100498 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
499
John Zulauff660ad62019-03-23 07:16:05 -0600500 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
501 // in common with the non-const version.)
502 const ImageSubresourceLayoutMap *subresource_map =
503 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
504
505 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
John Zulauf02a204c2019-04-23 18:52:11 -0600506 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -0600507 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600508 auto subresource_cb = [this, i, attachment_initial_layout, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600509 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -0600510 if (!layout_check.Check(subres, attachment_initial_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600511 subres_skip |=
512 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
513 kVUID_Core_DrawState_InvalidRenderpass,
514 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
515 "and the %s layout of the attachment is %s. The layouts must match, or the render "
516 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
517 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
518 string_VkImageLayout(layout_check.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700519 }
John Zulauff660ad62019-03-23 07:16:05 -0600520 return !subres_skip; // quit checking subresources once we fail once
521 };
522
523 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
524 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700525 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100526
John Zulauff660ad62019-03-23 07:16:05 -0600527 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view, framebuffer,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700528 render_pass, i, "initial layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100529
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700530 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer, render_pass,
531 i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100532 }
533
534 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
535 auto &subpass = pRenderPassInfo->pSubpasses[j];
536 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
537 auto &attachment_ref = subpass.pInputAttachments[k];
538 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
539 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700540 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100541
542 if (view_state) {
543 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700544 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
545 framebuffer, render_pass, attachment_ref.attachment,
546 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100547 }
548 }
549 }
550
551 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
552 auto &attachment_ref = subpass.pColorAttachments[k];
553 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
554 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700555 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100556
557 if (view_state) {
558 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700559 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
560 framebuffer, render_pass, attachment_ref.attachment,
561 "color attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100562 if (subpass.pResolveAttachments) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700563 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
564 framebuffer, render_pass, attachment_ref.attachment,
565 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566 }
567 }
568 }
569 }
570
571 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
572 auto &attachment_ref = *subpass.pDepthStencilAttachment;
573 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
574 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700575 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100576
577 if (view_state) {
578 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700579 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
580 framebuffer, render_pass, attachment_ref.attachment,
581 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100582 }
583 }
584 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700585 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600586 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587}
588
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600589void CoreChecks::TransitionAttachmentRefLayout(CMD_BUFFER_STATE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700590 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700591 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700592 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600593 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600594 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600595 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700596 }
597}
598
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600599void CoreChecks::TransitionSubpassLayouts(CMD_BUFFER_STATE *pCB, const RENDER_PASS_STATE *render_pass_state,
600 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700601 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700602
603 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700604 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700605 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700606 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700607 }
608 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700609 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700610 }
611 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700612 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 }
614 }
615}
616
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700617// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
618// 1. Transition into initialLayout state
619// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600620void CoreChecks::TransitionBeginRenderPassLayouts(CMD_BUFFER_STATE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700621 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700622 // First transition into initialLayout
623 auto const rpci = render_pass_state->createInfo.ptr();
624 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700625 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600626 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600627 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600628 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700629 }
630 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700631 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700632}
633
Dave Houlton10b39482017-03-16 13:18:15 -0600634bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600635 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600636 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600637 }
638 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600639 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600640 }
641 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600642 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600643 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700644 if (0 !=
645 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
646 if (FormatPlaneCount(format) == 1) return false;
647 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600648 return true;
649}
650
Mike Weiblen62d08a32017-03-07 22:18:27 -0700651// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700652bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier *img_barrier, bool new_not_old,
653 VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700654 bool skip = false;
655 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600656 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700657
658 switch (layout) {
659 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
660 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600661 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662 }
663 break;
664 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
665 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600666 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700667 }
668 break;
669 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
670 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600671 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700672 }
673 break;
674 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
675 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600676 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 break;
679 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
680 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700682 }
683 break;
684 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
685 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600686 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700687 }
688 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600689 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500690 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
691 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
692 }
693 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 default:
695 // Other VkImageLayout values do not have VUs defined in this context.
696 break;
697 }
698
Dave Houlton8e9f6542018-05-18 12:18:22 -0600699 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600700 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 -0600701 HandleToUint64(img_barrier->image), msg_code,
John Zulauff660ad62019-03-23 07:16:05 -0600702 "%s: Image barrier 0x%p %s Layout=%s is not compatible with image %s usage flags 0x%" PRIx32 ".", func_name,
Lockee9aeebf2019-03-03 23:50:08 -0700703 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
704 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700705 }
706 return skip;
707}
708
John Zulauf463c51e2018-05-31 13:29:20 -0600709// Scoreboard for checking for duplicate and inconsistent barriers to images
710struct ImageBarrierScoreboardEntry {
711 uint32_t index;
712 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
713 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
714 const VkImageMemoryBarrier *barrier;
715};
716using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
717using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
718
Mike Weiblen62d08a32017-03-07 22:18:27 -0700719// Verify image barriers are compatible with the images they reference.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600720bool CoreChecks::ValidateBarriersToImages(CMD_BUFFER_STATE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700721 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700722 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700723
John Zulauf463c51e2018-05-31 13:29:20 -0600724 // Scoreboard for duplicate layout transition barriers within the list
725 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
726 ImageBarrierScoreboardImageMap layout_transitions;
727
Mike Weiblen62d08a32017-03-07 22:18:27 -0700728 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
729 auto img_barrier = &pImageMemoryBarriers[i];
730 if (!img_barrier) continue;
731
John Zulauf463c51e2018-05-31 13:29:20 -0600732 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
733 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
734 // at a per sub-resource level
735 if (img_barrier->oldLayout != img_barrier->newLayout) {
736 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
737 auto image_it = layout_transitions.find(img_barrier->image);
738 if (image_it != layout_transitions.end()) {
739 auto &subres_map = image_it->second;
740 auto subres_it = subres_map.find(img_barrier->subresourceRange);
741 if (subres_it != subres_map.end()) {
742 auto &entry = subres_it->second;
743 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
744 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
745 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
746 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700747 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
748 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700749 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600750 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
751 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700752 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700753 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
754 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600755 }
756 entry = new_entry;
757 } else {
758 subres_map[img_barrier->subresourceRange] = new_entry;
759 }
760 } else {
761 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
762 }
763 }
764
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700765 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600766 if (image_state) {
767 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700768 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name);
769 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600770
771 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
772 if (image_state->layout_locked) {
773 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600774 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700775 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
776 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700777 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600778 " from layout %s to layout %s, but image has already been presented and cannot have its layout transitioned.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700779 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
780 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600781 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600782
John Zulauff660ad62019-03-23 07:16:05 -0600783 VkImageCreateInfo *image_create_info = &image_state->createInfo;
784 // For a Depth/Stencil image both aspects MUST be set
785 if (FormatIsDepthAndStencil(image_create_info->format)) {
786 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
787 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
788 if ((aspect_mask & ds_mask) != (ds_mask)) {
789 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
790 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
791 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
792 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
793 func_name, static_cast<const void *>(img_barrier),
794 report_data->FormatHandle(img_barrier->image).c_str(),
795 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700796 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700797 }
John Zulauff660ad62019-03-23 07:16:05 -0600798
799 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier->image);
800 if (img_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
801 // TODO: Set memory invalid which is in mem_tracker currently
802 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
803 // subresource.
804 } else if (subresource_map) {
805 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -0600806 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -0600807 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier->subresourceRange);
John Zulauf02a204c2019-04-23 18:52:11 -0600808 auto subres_callback = [this, img_barrier, cb_state, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -0600809 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -0600810 if (!layout_check.Check(subres, img_barrier->oldLayout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -0600811 subres_skip =
812 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
813 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
814 "For image %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
815 "%s layout is %s.",
816 report_data->FormatHandle(img_barrier->image).c_str(), subres.aspectMask, subres.mipLevel,
817 subres.arrayLayer, string_VkImageLayout(img_barrier->oldLayout), layout_check.message,
818 string_VkImageLayout(layout_check.layout));
819 }
820 return !subres_skip;
821 };
822 subresource_map->ForRange(normalized_isr, subres_callback);
823 skip |= subres_skip;
824 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700825 }
826 }
827 return skip;
828}
829
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600830bool CoreChecks::IsReleaseOp(CMD_BUFFER_STATE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600831 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700832
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600833 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700834 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700835}
836
John Zulauf6b4aae82018-05-09 13:03:36 -0600837template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600838bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state, uint32_t barrier_count,
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700839 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600840 using BarrierRecord = QFOTransferBarrier<Barrier>;
841 bool skip = false;
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600842 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600843 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
844 const char *barrier_name = BarrierRecord::BarrierName();
845 const char *handle_name = BarrierRecord::HandleName();
846 const char *transfer_type = nullptr;
847 for (uint32_t b = 0; b < barrier_count; b++) {
848 if (!IsTransferOp(&barriers[b])) continue;
849 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700850 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
851 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600852 const auto found = barrier_sets.release.find(barriers[b]);
853 if (found != barrier_sets.release.cend()) {
854 barrier_record = &(*found);
855 transfer_type = "releasing";
856 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600857 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
858 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600859 const auto found = barrier_sets.acquire.find(barriers[b]);
860 if (found != barrier_sets.acquire.cend()) {
861 barrier_record = &(*found);
862 transfer_type = "acquiring";
863 }
864 }
865 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700866 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
867 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
868 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
869 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
870 func_name, barrier_name, b, transfer_type, handle_name,
871 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
872 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600873 }
874 }
875 return skip;
876}
877
878template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600879void CoreChecks::RecordQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -0600880 auto pool = GetCommandPoolState(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600881 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
882 for (uint32_t b = 0; b < barrier_count; b++) {
883 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700884 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
885 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600886 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600887 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
888 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600889 barrier_sets.acquire.emplace(barriers[b]);
890 }
891 }
892}
893
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600894bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, CMD_BUFFER_STATE *cb_state,
895 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700896 uint32_t imageMemBarrierCount,
897 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600898 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700899 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
900 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600901 return skip;
902}
903
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600904void CoreChecks::RecordBarriersQFOTransfers(CMD_BUFFER_STATE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700905 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
906 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700907 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
908 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600909}
910
911template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600912bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700913 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600914 // Record to the scoreboard or report that we have a duplication
915 bool skip = false;
916 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
917 if (!inserted.second && inserted.first->second != cb_state) {
918 // 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 -0700919 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
920 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
921 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
922 " duplicates existing barrier submitted in this batch from command buffer %s.",
923 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
924 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -0600925 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600926 }
927 return skip;
928}
929
930template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600931bool CoreChecks::ValidateQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state, QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600932 using BarrierRecord = QFOTransferBarrier<Barrier>;
933 using TypeTag = typename BarrierRecord::Tag;
934 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700936 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600937 const char *barrier_name = BarrierRecord::BarrierName();
938 const char *handle_name = BarrierRecord::HandleName();
939 // No release should have an extant duplicate (WARNING)
940 for (const auto &release : cb_barriers.release) {
941 // Check the global pending release barriers
942 const auto set_it = global_release_barriers.find(release.handle);
943 if (set_it != global_release_barriers.cend()) {
944 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
945 const auto found = set_for_handle.find(release);
946 if (found != set_for_handle.cend()) {
947 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
948 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700949 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600950 " to dstQueueFamilyIndex %" PRIu32
951 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700952 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600953 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
954 }
955 }
956 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
957 }
958 // Each acquire must have a matching release (ERROR)
959 for (const auto &acquire : cb_barriers.acquire) {
960 const auto set_it = global_release_barriers.find(acquire.handle);
961 bool matching_release_found = false;
962 if (set_it != global_release_barriers.cend()) {
963 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
964 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
965 }
966 if (!matching_release_found) {
967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
968 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700969 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
970 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
971 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600972 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
973 }
974 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
975 }
976 return skip;
977}
978
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600979bool CoreChecks::ValidateQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700980 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
981 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600982 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700983 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
984 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600985 return skip;
986}
987
988template <typename Barrier>
Mark Lobodzinski33a34b82019-04-25 11:38:36 -0600989void CoreChecks::RecordQueuedQFOTransferBarriers(CMD_BUFFER_STATE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600990 using BarrierRecord = QFOTransferBarrier<Barrier>;
991 using TypeTag = typename BarrierRecord::Tag;
992 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700993 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600994
995 // Add release barriers from this submit to the global map
996 for (const auto &release : cb_barriers.release) {
997 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
998 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
999 global_release_barriers[release.handle].insert(release);
1000 }
1001
1002 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1003 for (const auto &acquire : cb_barriers.acquire) {
1004 // NOTE: We're not using [] because we don't want to create entries for missing releases
1005 auto set_it = global_release_barriers.find(acquire.handle);
1006 if (set_it != global_release_barriers.end()) {
1007 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1008 set_for_handle.erase(acquire);
1009 if (set_for_handle.size() == 0) { // Clean up empty sets
1010 global_release_barriers.erase(set_it);
1011 }
1012 }
1013 }
1014}
1015
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001016void CoreChecks::RecordQueuedQFOTransfers(CMD_BUFFER_STATE *cb_state) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001017 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1018 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001019}
1020
John Zulauf6b4aae82018-05-09 13:03:36 -06001021// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001022void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001023
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001024void CoreChecks::TransitionImageLayouts(CMD_BUFFER_STATE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001025 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001026 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1027 auto mem_barrier = &pImgMemBarriers[i];
1028 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001029
Chris Forbes4de4b132017-08-21 11:27:08 -07001030 // For ownership transfers, the barrier is specified twice; as a release
1031 // operation on the yielding queue family, and as an acquire operation
1032 // on the acquiring queue family. This barrier may also include a layout
1033 // transition, which occurs 'between' the two operations. For validation
1034 // purposes it doesn't seem important which side performs the layout
1035 // transition, but it must not be performed twice. We'll arbitrarily
1036 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001037 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001038 continue;
1039 }
1040
John Zulauff660ad62019-03-23 07:16:05 -06001041 auto *image_state = GetImageState(mem_barrier->image);
1042 if (!image_state) continue;
1043
1044 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier->subresourceRange);
1045 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001046
Dave Houltonb3f4b282018-02-22 16:25:16 -07001047 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1048 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1049 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001050 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1051 normalized_isr.baseArrayLayer = 0;
1052 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001053 }
1054
John Zulauff660ad62019-03-23 07:16:05 -06001055 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier->newLayout, mem_barrier->oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001056 }
1057}
1058
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001059bool CoreChecks::VerifyImageLayout(CMD_BUFFER_STATE const *cb_node, IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
John Zulaufabcc8292019-04-08 18:07:44 -06001060 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
1061 const char *caller, const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code,
1062 bool *error) {
John Zulauff660ad62019-03-23 07:16:05 -06001063 assert(cb_node);
1064 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001065 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001066 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001067
John Zulauff660ad62019-03-23 07:16:05 -06001068 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1069 if (subresource_map) {
1070 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001071 LayoutUseCheckAndMessage layout_check(subresource_map, aspect_mask);
1072 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &layout_check, &error,
John Zulaufabcc8292019-04-08 18:07:44 -06001073 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001074 if (!layout_check.Check(subres, explicit_layout, layout, initial_layout)) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001075 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001076 subres_skip |=
1077 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1078 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1079 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1080 "%s layout %s.",
1081 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1082 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001083 }
John Zulauff660ad62019-03-23 07:16:05 -06001084 return !subres_skip;
1085 };
1086 subresource_map->ForRange(range, subresource_cb);
1087 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001088 }
John Zulauff660ad62019-03-23 07:16:05 -06001089
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001090 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1091 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1092 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001093 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1094 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001095 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001096 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001097 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001098 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1099 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001100 }
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001101 } else if (device_extensions.vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001102 if (image_state->shared_presentable) {
1103 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001104 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1105 layout_invalid_msg_code,
1106 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1107 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001108 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001109 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001110 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001111 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001112 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 -07001113 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001114 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1115 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1116 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001117 }
1118 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001119 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001120}
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001121bool CoreChecks::VerifyImageLayout(CMD_BUFFER_STATE const *cb_node, IMAGE_STATE *image_state,
John Zulauff660ad62019-03-23 07:16:05 -06001122 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1123 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
1124 const char *layout_mismatch_msg_code, bool *error) {
1125 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1126 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1127}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001128
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001129void CoreChecks::TransitionFinalSubpassLayouts(CMD_BUFFER_STATE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001130 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001131 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001132 if (!renderPass) return;
1133
Tobias Hectorbbb12282018-10-22 15:17:59 +01001134 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001135 if (framebuffer_state) {
1136 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001137 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001138 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001139 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001140 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001141 }
1142 }
1143}
Dave Houltone19e20d2018-02-02 16:32:41 -07001144
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001145#ifdef VK_USE_PLATFORM_ANDROID_KHR
1146// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1147// This could also move into a seperate core_validation_android.cpp file... ?
1148
1149//
1150// AHB-specific validation within non-AHB APIs
1151//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001152bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001153 bool skip = false;
1154
1155 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1156 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001157 if (0 != ext_fmt_android->externalFormat) {
1158 if (VK_FORMAT_UNDEFINED != create_info->format) {
1159 skip |=
1160 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1161 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001162 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001163 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1164 }
1165
1166 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1167 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1168 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001169 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001170 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1171 }
1172
1173 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1174 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1175 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001176 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001177 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1178 }
1179
1180 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1181 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1182 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001183 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001184 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1185 }
1186 }
1187
Mark Lobodzinski1ee06e92019-04-19 14:03:53 -06001188 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1190 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001191 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001192 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1193 }
1194 }
1195
Dave Houltond9611312018-11-19 17:03:36 -07001196 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001197 if (VK_FORMAT_UNDEFINED == create_info->format) {
1198 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1199 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001200 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001201 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1202 }
1203 }
1204
1205 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1206 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1207 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001208 skip |=
1209 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1210 "VUID-VkImageCreateInfo-pNext-02393",
1211 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1212 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1213 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001214 }
1215
1216 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1217 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1218 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001219 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001220 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1221 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1222 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1223 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001224 }
1225
1226 return skip;
1227}
1228
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001229void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001230 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1231 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1232 is_node->imported_ahb = true;
1233 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001234 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001235 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001236 is_node->has_ahb_format = true;
1237 is_node->ahb_format = ext_fmt_android->externalFormat;
1238 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001239}
1240
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001241bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001242 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001243 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001244
1245 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001246 if (VK_FORMAT_UNDEFINED != create_info->format) {
1247 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1248 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1249 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1250 "format member is %s.",
1251 string_VkFormat(create_info->format));
1252 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001253
Dave Houltond9611312018-11-19 17:03:36 -07001254 // Chain must include a compatible ycbcr conversion
1255 bool conv_found = false;
1256 uint64_t external_format = 0;
1257 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1258 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001259 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001260 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001261 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001262 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001263 }
Dave Houltond9611312018-11-19 17:03:36 -07001264 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001265 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001266 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 -07001267 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1268 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1269 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1270 }
1271
1272 // Errors in create_info swizzles
1273 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1274 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1275 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1276 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1277 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1278 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1279 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1280 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 }
1282 }
Dave Houltond9611312018-11-19 17:03:36 -07001283
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001284 return skip;
1285}
1286
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001287bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001288 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001289
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001290 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001291 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1292 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1293 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001294 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001295 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1296 "bound to memory.");
1297 }
1298 return skip;
1299}
1300
1301#else
1302
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001303bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304 return false;
1305}
1306
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001307void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001308
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001309bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001310
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001311bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001312
1313#endif // VK_USE_PLATFORM_ANDROID_KHR
1314
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001315bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1316 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001317 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001318
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001319 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001320 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001321 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1322 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1323 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1324 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001325 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001326 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001327 }
1328
Mark Lobodzinskidef4c092019-06-18 13:08:01 -06001329 if (pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) {
1330 if (VK_IMAGE_TYPE_2D != pCreateInfo->imageType) {
1331 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1332 "VUID-VkImageCreateInfo-flags-00949",
1333 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT "
1334 "flag bit is set");
1335 }
1336
1337 if ((pCreateInfo->extent.width != pCreateInfo->extent.height) || (pCreateInfo->arrayLayers < 6)) {
1338 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1339 "VUID-VkImageCreateInfo-imageType-00954",
1340 "vkCreateImage(): If VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set, width (%d) must equal "
1341 "height (%d) and arrayLayers (%d) must be >= 6.",
1342 pCreateInfo->extent.width, pCreateInfo->extent.height, pCreateInfo->arrayLayers);
1343 }
Dave Houlton130c0212018-01-29 13:39:56 -07001344 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001345
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001346 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001347 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1348 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1349 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001350 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 +00001351 "VUID-VkImageCreateInfo-usage-00964",
1352 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1353 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001354 }
1355
1356 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001357 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 +00001358 "VUID-VkImageCreateInfo-usage-00965",
1359 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1360 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001361 }
1362
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001363 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001364 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001365 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
Lockee87f87c2019-04-23 17:53:10 -06001366#ifdef VK_USE_PLATFORM_ANDROID_KHR
1367 if (!lvl_find_in_chain<VkExternalFormatANDROID>(pCreateInfo->pNext))
1368#endif // VK_USE_PLATFORM_ANDROID_KHR
1369 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1370 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1371 string_VkFormat(pCreateInfo->format));
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001372 } else {
1373 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1374 const char *format_string = string_VkFormat(pCreateInfo->format);
1375 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1376 "VUID-VkImageCreateInfo-mipLevels-02255",
1377 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1378 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1379 }
Dave Houlton130c0212018-01-29 13:39:56 -07001380
Dave Houltona585d132019-01-18 13:05:42 -07001381 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1382 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1383 (uint64_t)pCreateInfo->samples;
1384 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001385
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001386 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001387 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001388 uint64_t ig_mask = imageGranularity - 1;
1389 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001390
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001391 if (total_size > format_limits.maxResourceSize) {
1392 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1393 kVUID_Core_Image_InvalidFormatLimitsViolation,
1394 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1395 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1396 total_size, format_limits.maxResourceSize);
1397 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001398
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001399 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1400 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1401 "VUID-VkImageCreateInfo-arrayLayers-02256",
1402 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1403 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1404 }
1405
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001406 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1407 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001408 skip |= log_msg(
1409 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1410 "VUID-VkImageCreateInfo-format-02653",
1411 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1412 pCreateInfo->arrayLayers);
1413 }
1414
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001415 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1416 skip |=
1417 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1418 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001419 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001420 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001421 }
1422
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001423 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001424 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 -06001425 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001426 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1427 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001428 }
1429
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001430 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001431 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1432 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1433 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1434 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001435 skip |=
1436 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1437 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1438 "format must be block, ETC or ASTC compressed, but is %s",
1439 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001440 }
1441 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1442 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001443 skip |=
1444 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1445 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1446 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001447 }
1448 }
1449 }
1450
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001451 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001452 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1453 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1454 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001455 }
1456
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001457 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001458}
1459
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001460void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1461 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001462 if (VK_SUCCESS != result) return;
Mark Lobodzinskidb7a9fc2019-04-25 11:56:26 -06001463 IMAGE_LAYOUT_STATE image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001464 image_state.layout = pCreateInfo->initialLayout;
1465 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001466 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001467 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001468 RecordCreateImageANDROID(pCreateInfo, is_node);
1469 }
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001470 imageMap.insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001471 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001472 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001473 imageLayoutMap[subpair] = image_state;
1474 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001475}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001476
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001477bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001478 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001479 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001480 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001481 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001482 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001483 }
1484 return skip;
1485}
1486
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001487void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001488 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001489 IMAGE_STATE *image_state = GetImageState(image);
John Zulauf4fea6622019-04-01 11:38:18 -06001490 const VulkanTypedHandle obj_struct(image, kVulkanObjectTypeImage);
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001491 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001492 // Clean up memory mapping, bindings and range references for image
1493 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06001494 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001495 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001496 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001497 }
1498 }
John Zulauf4fea6622019-04-01 11:38:18 -06001499 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001500 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001501 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001502 imageMap.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001503
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001504 const auto &sub_entry = imageSubresourceMap.find(image);
1505 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001506 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001507 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001509 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001510 }
1511}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001512
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001513bool CoreChecks::ValidateImageAttributes(IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001514 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001515
1516 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1517 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1518 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 -06001519 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001520 }
1521
Dave Houlton1d2022c2017-03-29 11:43:58 -06001522 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001523 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1524 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 -06001525 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001526 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001527 char const str[] = "vkCmdClearColorImage called with compressed image.";
1528 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 -06001529 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001530 }
1531
1532 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1533 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1534 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 -06001535 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001536 }
1537 return skip;
1538}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001539
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001540uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1541 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1542 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001543 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001544 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001545 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001546 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001547}
1548
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001549uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1550 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1551 uint32_t array_layer_count = range->layerCount;
1552 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1553 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001554 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001555 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001556}
1557
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001558bool CoreChecks::VerifyClearImageLayout(CMD_BUFFER_STATE *cb_node, IMAGE_STATE *image_state, VkImageSubresourceRange range,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001559 VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001560 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001561
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001562 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1563 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001564 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1565 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001566 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 -06001567 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001568 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1569 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001570 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001571 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001572 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001573 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 -06001574 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001575 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1576 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001577
1578 } else {
1579 if (image_state->shared_presentable) {
1580 skip |= log_msg(
1581 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001582 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001583 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1584 string_VkImageLayout(dest_image_layout));
1585 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001586 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001587 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001588 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001589 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001590 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001591 } else {
1592 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1593 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001594 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 -06001595 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001596 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1597 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001598 }
1599 }
1600
John Zulauff660ad62019-03-23 07:16:05 -06001601 // Cast to const to prevent creation at validate time.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001602 const auto *subresource_map = GetImageSubresourceLayoutMap(static_cast<const CMD_BUFFER_STATE *>(cb_node), image_state->image);
John Zulauff660ad62019-03-23 07:16:05 -06001603 if (subresource_map) {
1604 bool subres_skip = false;
John Zulauf02a204c2019-04-23 18:52:11 -06001605 LayoutUseCheckAndMessage layout_check(subresource_map);
John Zulauff660ad62019-03-23 07:16:05 -06001606 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
John Zulauf02a204c2019-04-23 18:52:11 -06001607 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &layout_check, &subres_skip](
John Zulauff660ad62019-03-23 07:16:05 -06001608 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
John Zulauf02a204c2019-04-23 18:52:11 -06001609 if (!layout_check.Check(subres, dest_image_layout, layout, initial_layout)) {
John Zulauff660ad62019-03-23 07:16:05 -06001610 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1611 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1612 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1613 } else {
1614 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001615 }
John Zulauff660ad62019-03-23 07:16:05 -06001616 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1617 HandleToUint64(cb_node->commandBuffer), error_code,
1618 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1619 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1620 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001621 }
John Zulauff660ad62019-03-23 07:16:05 -06001622 return !subres_skip;
1623 };
1624 subresource_map->ForRange(normalized_isr, subres_callback);
1625 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001626 }
1627
1628 return skip;
1629}
1630
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001631bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1632 const VkClearColorValue *pColor, uint32_t rangeCount,
1633 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001634 bool skip = false;
1635 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001636 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001637 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001638 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001639 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001640 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001641 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001642 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001643 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001644 skip |=
1645 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1646 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001647 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001648 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001649 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001650 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001651 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001652 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1653 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 }
1655 }
1656 return skip;
1657}
1658
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001659void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1660 const VkClearColorValue *pColor, uint32_t rangeCount,
1661 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001662 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001663 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001664 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001665 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001666 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001667 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001668 }
1669 }
1670}
1671
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001672bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1673 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1674 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001675 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001676
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001677 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001678 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001679 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001680 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001681 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001682 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001683 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001684 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001685 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski544def72019-04-19 14:25:59 -06001686 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001687 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1688 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001689 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001690 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001691 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001692 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001693 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001694 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001695 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001696 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001697 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1698 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001699 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001700 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1701 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001702 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 -06001703 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001704 }
1705 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001706 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001707 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001708 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 -06001709 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001710 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001711 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1712 char const str[] =
1713 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1714 "set.";
1715 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 -06001716 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001717 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001718 }
1719 return skip;
1720}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001721
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001722void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1723 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1724 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06001725 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001726 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001727 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001728 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001729 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001730 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001731 }
1732 }
1733}
1734
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001735// Returns true if [x, xoffset] and [y, yoffset] overlap
1736static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1737 bool result = false;
1738 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1739 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1740
1741 if (intersection_max > intersection_min) {
1742 result = true;
1743 }
1744 return result;
1745}
1746
Dave Houltonc991cc92018-03-06 11:08:51 -07001747// Returns true if source area of first copy region intersects dest area of second region
1748// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1749static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001750 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001751
Dave Houltonc991cc92018-03-06 11:08:51 -07001752 // Separate planes within a multiplane image cannot intersect
1753 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001754 return result;
1755 }
1756
Dave Houltonc991cc92018-03-06 11:08:51 -07001757 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1758 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1759 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001760 result = true;
1761 switch (type) {
1762 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001763 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001764 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001765 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001766 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001767 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001768 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001769 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001770 break;
1771 default:
1772 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1773 assert(false);
1774 }
1775 }
1776 return result;
1777}
1778
Dave Houltonfc1a4052017-04-27 14:32:45 -06001779// Returns non-zero if offset and extent exceed image extents
1780static const uint32_t x_bit = 1;
1781static const uint32_t y_bit = 2;
1782static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001783static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001784 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001785 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001786 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1787 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001788 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001789 }
1790 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1791 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001792 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001793 }
1794 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1795 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001796 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001797 }
1798 return result;
1799}
1800
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001801// Test if two VkExtent3D structs are equivalent
1802static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1803 bool result = true;
1804 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1805 (extent->depth != other_extent->depth)) {
1806 result = false;
1807 }
1808 return result;
1809}
1810
Dave Houltonee281a52017-12-08 13:51:02 -07001811// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1812// Destination image texel extents must be adjusted by block size for the dest validation checks
1813VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1814 VkExtent3D adjusted_extent = extent;
1815 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001816 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001817 adjusted_extent.width /= block_size.width;
1818 adjusted_extent.height /= block_size.height;
1819 adjusted_extent.depth /= block_size.depth;
1820 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001821 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001822 adjusted_extent.width *= block_size.width;
1823 adjusted_extent.height *= block_size.height;
1824 adjusted_extent.depth *= block_size.depth;
1825 }
1826 return adjusted_extent;
1827}
1828
Dave Houlton6f9059e2017-05-02 17:15:13 -06001829// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001830static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1831 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001832
1833 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001834 if (mip >= img->createInfo.mipLevels) {
1835 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001836 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001837
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001838 // 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 -06001839 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001840
Dave Houltone48cd112019-01-03 17:01:18 -07001841 // If multi-plane, adjust per-plane extent
1842 if (FormatIsMultiplane(img->createInfo.format)) {
1843 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1844 extent.width /= divisors.width;
1845 extent.height /= divisors.height;
1846 }
1847
Jeff Bolzef40fec2018-09-01 22:04:34 -05001848 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1849 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001850 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001851 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1852 } else {
1853 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1854 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1855 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1856 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001857
Dave Houlton6f9059e2017-05-02 17:15:13 -06001858 // Image arrays have an effective z extent that isn't diminished by mip level
1859 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001860 extent.depth = img->createInfo.arrayLayers;
1861 }
1862
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001863 return extent;
1864}
1865
1866// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001867static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001868 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1869}
1870
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001871// Test if the extent argument has any dimensions set to 0.
1872static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1873 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1874}
1875
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001876// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001877VkExtent3D CoreChecks::GetScaledItg(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001878 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1879 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06001880 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001881 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001882 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001883 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001884 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001885 granularity.width *= block_size.width;
1886 granularity.height *= block_size.height;
1887 }
1888 }
1889 return granularity;
1890}
1891
1892// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1893static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1894 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001895 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1896 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001897 valid = false;
1898 }
1899 return valid;
1900}
1901
1902// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001903bool CoreChecks::CheckItgOffset(const CMD_BUFFER_STATE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001904 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001905 bool skip = false;
1906 VkExtent3D offset_extent = {};
1907 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1908 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1909 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001910 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001911 // 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 -07001912 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001913 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 -04001914 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001915 "%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 "
1916 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001917 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918 }
1919 } else {
1920 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1921 // integer multiples of the image transfer granularity.
1922 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001923 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 -04001924 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001925 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1926 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001927 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1928 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001929 }
1930 }
1931 return skip;
1932}
1933
1934// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001935bool CoreChecks::CheckItgExtent(const CMD_BUFFER_STATE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001936 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
1937 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001938 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001939 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001940 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1941 // subresource extent.
1942 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001943 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 -04001944 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001945 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1946 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1947 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1948 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001949 }
1950 } else {
1951 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1952 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1953 // subresource extent dimensions.
1954 VkExtent3D offset_extent_sum = {};
1955 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1956 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1957 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001958 bool x_ok = true;
1959 bool y_ok = true;
1960 bool z_ok = true;
1961 switch (image_type) {
1962 case VK_IMAGE_TYPE_3D:
1963 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1964 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001965 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001966 case VK_IMAGE_TYPE_2D:
1967 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1968 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001969 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001970 case VK_IMAGE_TYPE_1D:
1971 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1972 (subresource_extent->width == offset_extent_sum.width));
1973 break;
1974 default:
1975 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1976 assert(false);
1977 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001978 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001979 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 (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1982 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1983 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1984 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1985 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1986 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001987 }
1988 }
1989 return skip;
1990}
1991
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06001992bool CoreChecks::ValidateImageMipLevel(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, uint32_t mip_level,
1993 const uint32_t i, const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001994 bool skip = false;
1995 if (mip_level >= img->createInfo.mipLevels) {
1996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1997 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07001998 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
1999 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002000 }
2001 return skip;
2002}
2003
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002004bool CoreChecks::ValidateImageArrayLayerRange(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002005 const uint32_t layer_count, const uint32_t i, const char *function,
2006 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002007 bool skip = false;
2008 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2009 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2010 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2011 HandleToUint64(cb_node->commandBuffer), vuid,
2012 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002013 "%u, but provided image %s has %u array layers.",
2014 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2015 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002016 }
2017 return skip;
2018}
2019
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002020// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002021bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002022 const VkBufferImageCopy *region, const uint32_t i,
2023 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002024 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002025 VkExtent3D granularity = GetScaledItg(cb_node, img);
2026 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002027 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002028 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002029 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002030 return skip;
2031}
2032
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002033// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002034bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const CMD_BUFFER_STATE *cb_node, const IMAGE_STATE *src_img,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002035 const IMAGE_STATE *dst_img, const VkImageCopy *region,
2036 const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002038 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002039 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2040 skip |=
2041 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002042 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002043 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002044 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2045 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002046
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002047 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002048 granularity = GetScaledItg(cb_node, dst_img);
2049 skip |=
2050 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002051 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002052 const VkExtent3D dest_effective_extent =
2053 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002054 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002055 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002056 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002057 return skip;
2058}
2059
Dave Houlton6f9059e2017-05-02 17:15:13 -06002060// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002061bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002062 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002063 bool skip = false;
2064
2065 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002066 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002067
2068 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002069 const VkExtent3D src_copy_extent = region.extent;
2070 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002071 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2072
Dave Houlton6f9059e2017-05-02 17:15:13 -06002073 bool slice_override = false;
2074 uint32_t depth_slices = 0;
2075
2076 // Special case for copying between a 1D/2D array and a 3D image
2077 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2078 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002079 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002080 slice_override = (depth_slices != 1);
2081 } 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 -07002082 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002083 slice_override = (depth_slices != 1);
2084 }
2085
2086 // Do all checks on source image
2087 //
2088 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002089 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2090 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 -06002091 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002092 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002093 "be 0 and 1, respectively.",
2094 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002095 }
2096 }
2097
Dave Houlton533be9f2018-03-26 17:08:30 -06002098 // VUID-VkImageCopy-srcImage-01785
2099 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2100 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 -06002101 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002102 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002103 "these must be 0 and 1, respectively.",
2104 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002105 }
2106
Dave Houlton533be9f2018-03-26 17:08:30 -06002107 // VUID-VkImageCopy-srcImage-01787
2108 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2109 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 -06002110 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002111 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2112 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002113 }
2114
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002115 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002116 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002117 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002118 skip |=
2119 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002120 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002122 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2123 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 }
2125 }
2126 } else { // Pre maint 1
2127 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002128 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002129 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 -06002130 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002131 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2132 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002133 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2134 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002135 }
2136 }
2137 }
2138
Dave Houltonc991cc92018-03-06 11:08:51 -07002139 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002140 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002141 if (FormatIsCompressed(src_state->createInfo.format) ||
2142 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002143 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002144 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002145 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2146 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2147 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002148 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002149 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 -07002150 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002151 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002152 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002153 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002154 }
2155
Dave Houlton94a00372017-12-14 15:08:47 -07002156 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002157 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2158 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002159 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002160 skip |=
2161 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002162 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002163 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002164 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002165 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002166 }
2167
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002168 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002169 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2170 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002171 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002172 skip |=
2173 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002174 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002175 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002176 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002177 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002178 }
2179
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002180 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002181 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2182 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002183 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
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 Houltonc991cc92018-03-06 11:08:51 -07002186 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002187 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002188 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002189 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002190 }
2191 } // Compressed
2192
2193 // Do all checks on dest image
2194 //
2195 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002196 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002197 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 -06002198 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002199 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002200 "these must be 0 and 1, respectively.",
2201 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002202 }
2203 }
2204
Dave Houlton533be9f2018-03-26 17:08:30 -06002205 // VUID-VkImageCopy-dstImage-01786
2206 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2207 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 -06002208 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002209 "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 -06002210 "and 1, respectively.",
2211 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002212 }
2213
2214 // VUID-VkImageCopy-dstImage-01788
2215 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2216 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 -06002217 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002218 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2219 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002220 }
2221
2222 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002223 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002224 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 -06002225 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002226 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002227 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2228 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 }
2230 }
2231 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002232 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002233 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002234 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002235 skip |=
2236 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002237 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002238 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002239 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2240 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002241 }
2242 }
2243 } else { // Pre maint 1
2244 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002245 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002246 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 -06002247 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002248 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2249 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002250 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2251 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 }
2253 }
2254 }
2255
Dave Houltonc991cc92018-03-06 11:08:51 -07002256 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2257 if (FormatIsCompressed(dst_state->createInfo.format) ||
2258 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002259 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002260
2261 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002262 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2263 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2264 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002265 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002266 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 -07002267 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002268 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002269 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002270 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002271 }
2272
Dave Houlton94a00372017-12-14 15:08:47 -07002273 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002274 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2275 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002276 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002277 skip |=
2278 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002279 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002280 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002281 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002282 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002283 }
2284
Dave Houltonee281a52017-12-08 13:51:02 -07002285 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2286 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2287 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002288 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002289 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 -07002290 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002291 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2292 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002293 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002294 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002295 }
2296
Dave Houltonee281a52017-12-08 13:51:02 -07002297 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2298 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2299 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002300 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002301 skip |=
2302 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002303 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002304 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002305 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002306 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 }
2308 } // Compressed
2309 }
2310 return skip;
2311}
2312
Dave Houltonc991cc92018-03-06 11:08:51 -07002313// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002314bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2315 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002316 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002317
2318 // Neither image is multiplane
2319 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2320 // If neither image is multi-plane the aspectMask member of src and dst must match
2321 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2322 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002323 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002324 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2325 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 -06002326 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002327 }
2328 } else {
2329 // Source image multiplane checks
2330 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2331 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2332 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2333 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002334 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002335 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 -06002336 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002337 }
2338 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2339 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2340 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002341 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002342 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 -06002343 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002344 }
2345 // Single-plane to multi-plane
2346 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2347 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2348 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002349 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002350 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 -06002351 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002352 }
2353
2354 // Dest image multiplane checks
2355 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2356 aspect = region.dstSubresource.aspectMask;
2357 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2358 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002359 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002360 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 -06002361 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002362 }
2363 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2364 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2365 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002366 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002367 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 -06002368 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002369 }
2370 // Multi-plane to single-plane
2371 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2372 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2373 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002374 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002375 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 -06002376 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 }
2378 }
2379
2380 return skip;
2381}
2382
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002383bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2384 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2385 const VkImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002386 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002387 auto src_image_state = GetImageState(srcImage);
2388 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002389 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002390
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002391 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002392
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002393 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2394
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002395 for (uint32_t i = 0; i < regionCount; i++) {
2396 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002397
2398 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2399 VkExtent3D src_copy_extent = region.extent;
2400 VkExtent3D dst_copy_extent =
2401 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2402
Dave Houlton6f9059e2017-05-02 17:15:13 -06002403 bool slice_override = false;
2404 uint32_t depth_slices = 0;
2405
2406 // Special case for copying between a 1D/2D array and a 3D image
2407 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2408 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2409 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002410 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002411 slice_override = (depth_slices != 1);
2412 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2413 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002414 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002415 slice_override = (depth_slices != 1);
2416 }
2417
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002418 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2419 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2420 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002421 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002422 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002423 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002424 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002425 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2426 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002427 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002428 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2429 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002430
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002431 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002432 // No chance of mismatch if we're overriding depth slice count
2433 if (!slice_override) {
2434 // The number of depth slices in srcSubresource and dstSubresource must match
2435 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2436 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002437 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2438 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002439 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002440 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2441 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002442 if (src_slices != dst_slices) {
2443 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002444 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002445 << "] do not match";
2446 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 -06002447 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002448 }
2449 }
2450 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002451 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002452 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002453 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002454 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002455 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002456 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 -06002457 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002458 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002459 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002460
Dave Houltonc991cc92018-03-06 11:08:51 -07002461 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002462 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002463 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002464 }
2465
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002466 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002467 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2468 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002469 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002470 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002471 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002472 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002473 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002474
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002475 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002476 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002477 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002478 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002479 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2480 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 -06002481 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002482 }
2483
2484 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002485 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002486 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002487 ss << "vkCmdCopyImage(): pRegion[" << i
2488 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002489 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 -06002490 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002491 }
2492
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002493 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2494 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2495 // 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 -07002496 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2497 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002498 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002499 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002500 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2501 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2502 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002503 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002504 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002505 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002506
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002507 // 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 -07002508 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2509 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002510 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002511 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002512 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2513 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2514 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002515 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 -06002516 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002517 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002518 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002519
Dave Houltonfc1a4052017-04-27 14:32:45 -06002520 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002521 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2522 if (slice_override) src_copy_extent.depth = depth_slices;
2523 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002524 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002525 skip |=
2526 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2527 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2528 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2529 "width [%1d].",
2530 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002531 }
2532
2533 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002534 skip |=
2535 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2536 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2537 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2538 "height [%1d].",
2539 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002540 }
2541 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002542 skip |=
2543 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2544 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2545 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2546 "depth [%1d].",
2547 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002548 }
2549
Dave Houltonee281a52017-12-08 13:51:02 -07002550 // Adjust dest extent if necessary
2551 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2552 if (slice_override) dst_copy_extent.depth = depth_slices;
2553
2554 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002555 if (extent_check & x_bit) {
2556 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 -06002557 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002558 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002559 "width [%1d].",
2560 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002561 }
2562 if (extent_check & y_bit) {
2563 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 -06002564 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002565 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002566 "height [%1d].",
2567 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002568 }
2569 if (extent_check & z_bit) {
2570 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 -06002571 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002572 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002573 "depth [%1d].",
2574 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002575 }
2576
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002577 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2578 // must not overlap in memory
2579 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002580 for (uint32_t j = 0; j < regionCount; j++) {
2581 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002582 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002583 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002584 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002585 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002586 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002587 }
2588 }
2589 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002590 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002591
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002592 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2593 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2594 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002595 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002596 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2597 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002598 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 -06002599 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002600 }
2601 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002602 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002603 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2604 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 -06002605 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002606 }
2607 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002608
Dave Houlton33c22b72017-02-28 13:16:02 -07002609 // Source and dest image sample counts must match
2610 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2611 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2612 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 -06002613 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002614 }
2615
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002616 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2617 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002618 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002619 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2620 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2621 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2622 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06002623 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002624 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2625 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2626 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2627 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002628 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002629 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002630 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002631 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2632 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002633 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002634 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2635 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2636 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2637 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2638 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2639 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002640 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002641 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002642 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2643 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002644 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002645 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2646 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002647 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2648 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002649 }
2650
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002651 return skip;
2652}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002653
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002654void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2655 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2656 const VkImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002657 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002658 auto src_image_state = GetImageState(srcImage);
2659 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002660
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002661 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002662 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002663 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2664 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002665 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002667 AddCommandBufferBindingImage(cb_node, src_image_state);
2668 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002669}
2670
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002671// Returns true if sub_rect is entirely contained within rect
2672static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2673 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2674 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2675 return false;
2676 return true;
2677}
2678
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002679bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002680 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2681 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002682 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002683 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2684 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002685 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002686 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002687
2688 for (uint32_t j = 0; j < rect_count; j++) {
2689 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002690 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 -07002691 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2692 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2693 "the current render pass instance.",
2694 j);
2695 }
2696
2697 if (image_view_state) {
2698 // The layers specified by a given element of pRects must be contained within every attachment that
2699 // pAttachments refers to
2700 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2701 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2702 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2704 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2705 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2706 "of pAttachment[%d].",
2707 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002708 }
2709 }
2710 }
2711 return skip;
2712}
2713
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002714bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2715 const VkClearAttachment *pAttachments, uint32_t rectCount,
2716 const VkClearRect *pRects) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002717 CMD_BUFFER_STATE *cb_node = GetCBState(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002718
2719 bool skip = false;
2720 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002721 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002722 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002723 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002724 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002725 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002726 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2727 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
Mark Lobodzinskid833bb72017-02-22 10:55:30 -07002728 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2729 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002730 skip |=
2731 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2732 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2733 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2734 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2735 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002736 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002737 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002738 }
2739
2740 // Validate that attachment is in reference list of active subpass
2741 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002742 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002743 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002744 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002745 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002746 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2747 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002748
John Zulauf3a548ef2019-02-01 16:14:07 -07002749 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2750 auto clear_desc = &pAttachments[attachment_index];
2751 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002752
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002753 if (0 == clear_desc->aspectMask) {
2754 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 -06002755 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002756 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2757 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002758 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002759 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002760 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2761 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2762 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2763 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002764 skip |= log_msg(
2765 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2766 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2767 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2768 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2769 attachment_index, clear_desc->colorAttachment,
2770 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2771 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2772
John Zulauff2582972019-02-09 14:53:30 -07002773 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2774 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002775 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002776 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2777 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2778 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2779 " subpass %u. colorAttachmentCount=%u",
2780 attachment_index, clear_desc->colorAttachment,
2781 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2782 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002783 }
John Zulauff2582972019-02-09 14:53:30 -07002784 fb_attachment = color_attachment;
2785
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002786 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2787 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2788 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002789 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002790 skip |=
2791 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2792 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002793 }
2794 } else { // Must be depth and/or stencil
2795 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2796 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002797 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002798 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 -07002799 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2800 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002801 }
2802 if (!subpass_desc->pDepthStencilAttachment ||
2803 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2804 skip |= log_msg(
2805 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002806 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002807 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002808 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002809 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002810 }
2811 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002812 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002813 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2814 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002815 } else {
2816 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2817 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2818 if (!clear_rect_copy) {
2819 // We need a copy of the clear rectangles that will persist until the last lambda executes
2820 // but we want to create it as lazily as possible
2821 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002822 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002823
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002824 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06002825 CMD_BUFFER_STATE *prim_cb, VkFramebuffer fb) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002826 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002827 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002828 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2829 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002830 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2831 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002832 return skip;
2833 };
2834 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002835 }
2836 }
2837 }
2838 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002839}
2840
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002841bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2842 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2843 const VkImageResolve *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002844 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002845 auto src_image_state = GetImageState(srcImage);
2846 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002847
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002848 bool skip = false;
2849 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002850 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2851 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002852 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002853 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002854 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2855 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002856 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2857 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002858
Cort Stratton7df30962018-05-17 19:45:57 -07002859 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002860 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002861 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002862 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2863 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2864 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002865 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002866 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2867 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002868 // For each region, the number of layers in the image subresource should not be zero
2869 // For each region, src and dest image aspect must be color only
2870 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002871 skip |=
2872 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2873 skip |=
2874 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002875 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002876 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2877 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002878 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002879 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2880 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002881 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2882 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2883 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2884 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2885 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002886 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2887 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002888 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002889 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2890 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002891
2892 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002893 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2894 skip |= log_msg(
2895 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002896 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002897 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002898 }
Cort Stratton7df30962018-05-17 19:45:57 -07002899 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002900 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2901 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2902 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002903 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002904 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 -06002905 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002906 }
2907 }
2908
2909 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2910 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002911 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 -06002912 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002913 }
2914 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2915 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002916 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 -06002917 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002918 }
2919 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2920 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2921 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 -06002922 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002923 }
2924 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2925 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2926 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002927 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002928 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002929 } else {
2930 assert(0);
2931 }
2932 return skip;
2933}
2934
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002935void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2936 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2937 const VkImageResolve *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002938 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002939 auto src_image_state = GetImageState(srcImage);
2940 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002941
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002942 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002943 AddCommandBufferBindingImage(cb_node, src_image_state);
2944 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002945}
2946
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002947bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2948 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2949 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06002950 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002951 auto src_image_state = GetImageState(srcImage);
2952 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002953
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002954 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002955 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002956 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002957 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002958 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002959 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002960 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002961 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002962 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002963 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2964 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002965 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002966 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2967 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002968 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002969 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2970 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002971 skip |=
2972 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002973 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2974 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002975 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002976 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002977 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002978 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002979
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002980 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002981
Dave Houlton33c2d252017-06-09 17:08:32 -06002982 VkFormat src_format = src_image_state->createInfo.format;
2983 VkFormat dst_format = dst_image_state->createInfo.format;
2984 VkImageType src_type = src_image_state->createInfo.imageType;
2985 VkImageType dst_type = dst_image_state->createInfo.imageType;
2986
Cort Stratton186b1a22018-05-01 20:18:06 -04002987 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002988 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002989 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2990 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002991 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002992 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
2993 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
2994 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002995 }
2996
2997 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2998 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 -06002999 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003000 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003001 }
3002
Dave Houlton33c2d252017-06-09 17:08:32 -06003003 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3004 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3005 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 -06003006 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003007 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003008 }
3009
3010 // Validate consistency for unsigned formats
3011 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3012 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003013 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003014 << "the other one must also have unsigned integer format. "
3015 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3016 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 -06003017 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003018 }
3019
3020 // Validate consistency for signed formats
3021 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3022 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003023 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003024 << "the other one must also have signed integer format. "
3025 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3026 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 -06003027 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003028 }
3029
3030 // Validate filter for Depth/Stencil formats
3031 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3032 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003033 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003034 << "then filter must be VK_FILTER_NEAREST.";
3035 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 -06003036 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003037 }
3038
3039 // Validate aspect bits and formats for depth/stencil images
3040 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3041 if (src_format != dst_format) {
3042 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003043 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003044 << "stencil, the other one must have exactly the same format. "
3045 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3046 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003047 skip |=
3048 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3049 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003050 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003051 } // Depth or Stencil
3052
3053 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003054 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003055 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003056 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3057 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3058 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003059 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003060 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3061 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003062 for (uint32_t i = 0; i < regionCount; i++) {
3063 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003064 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003065 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003066 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3067 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003068 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003069 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3070 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003071 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3072 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3073 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003074 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003075 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003076 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003077 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003078 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3079 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003080 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003081 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3082 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003083 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003084 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3085 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003086 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003087 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003088 skip |=
3089 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3090 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003091 }
Dave Houlton48989f32017-05-26 15:01:46 -06003092 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3093 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003094 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003095 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003096 skip |=
3097 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3098 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003099 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003100
3101 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003102 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003103 skip |= log_msg(
3104 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3105 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3106 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003107 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003108
Dave Houlton48989f32017-05-26 15:01:46 -06003109 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003110 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 -06003111 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003112 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003113 }
Dave Houlton48989f32017-05-26 15:01:46 -06003114
Dave Houlton33c2d252017-06-09 17:08:32 -06003115 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3116 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 -06003117 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003118 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003119 "image format %s.",
3120 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003121 }
3122
3123 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3124 skip |= log_msg(
3125 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003126 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003127 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3128 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003129 }
3130
Dave Houlton48989f32017-05-26 15:01:46 -06003131 // Validate source image offsets
3132 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003133 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003134 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003135 skip |=
3136 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3138 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3139 "of (%1d, %1d). These must be (0, 1).",
3140 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003141 }
3142 }
3143
Dave Houlton33c2d252017-06-09 17:08:32 -06003144 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003145 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3146 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 -06003147 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003148 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003149 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3150 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003151 }
3152 }
3153
Dave Houlton33c2d252017-06-09 17:08:32 -06003154 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003155 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3156 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003157 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003158 skip |= log_msg(
3159 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3160 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3161 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3162 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003163 }
3164 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3165 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003166 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003167 skip |= log_msg(
3168 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003169 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003170 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003171 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003172 }
3173 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3174 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003175 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003176 skip |= log_msg(
3177 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3178 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3179 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3180 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003181 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003182 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003183 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 -06003184 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003185 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003186 }
Dave Houlton48989f32017-05-26 15:01:46 -06003187
3188 // Validate dest image offsets
3189 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003190 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003191 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003192 skip |=
3193 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3194 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3195 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3196 "(%1d, %1d). These must be (0, 1).",
3197 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003198 }
3199 }
3200
Dave Houlton33c2d252017-06-09 17:08:32 -06003201 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003202 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3203 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 -06003204 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003205 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003206 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3207 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003208 }
3209 }
3210
Dave Houlton33c2d252017-06-09 17:08:32 -06003211 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003212 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3213 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003214 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003215 skip |= log_msg(
3216 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3217 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3218 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3219 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003220 }
3221 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3222 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003224 skip |= log_msg(
3225 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003226 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003227 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003228 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003229 }
3230 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3231 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003232 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003233 skip |= log_msg(
3234 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3235 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3236 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3237 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003238 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003239 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003240 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 -06003241 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003242 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003243 }
3244
Dave Houlton33c2d252017-06-09 17:08:32 -06003245 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3246 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3247 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003248 skip |=
3249 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3250 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3251 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3252 "layerCount other than 1.",
3253 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003254 }
3255 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003256 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003257 } else {
3258 assert(0);
3259 }
3260 return skip;
3261}
3262
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003263void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3264 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3265 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06003266 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003267 auto src_image_state = GetImageState(srcImage);
3268 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003269
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003270 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003271 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003272 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3273 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003274 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003275 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003276 AddCommandBufferBindingImage(cb_node, src_image_state);
3277 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003278}
3279
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003280// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinskidb7a9fc2019-04-25 11:56:26 -06003281bool CoreChecks::ValidateCmdBufImageLayouts(
3282 CMD_BUFFER_STATE *pCB, std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_STATE> const &globalImageLayoutMap,
3283 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_STATE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003284 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06003285 // Iterate over the layout maps for each referenced image
3286 for (const auto &layout_map_entry : pCB->image_layout_map) {
3287 const auto image = layout_map_entry.first;
3288 const auto *image_state = GetImageState(image);
3289 if (!image_state) continue; // Can't check layouts of a dead image
3290 const auto &subres_map = layout_map_entry.second;
3291 ImageSubresourcePair isr_pair;
3292 isr_pair.image = image;
3293 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003294
John Zulauff660ad62019-03-23 07:16:05 -06003295 // Validate the initial_uses for each subresource referenced
3296 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3297 isr_pair.subresource = (*it_init).subresource;
3298 VkImageLayout initial_layout = (*it_init).layout;
3299 VkImageLayout image_layout;
3300 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3301 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3302 // TODO: Set memory invalid which is in mem_tracker currently
3303 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003304 // Need to look up the inital layout *state* to get a bit more information
3305 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3306 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3307 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3308 if (!matches) {
3309 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3310 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3311 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3312 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, "
3313 "mip level %u) "
3314 "to be in layout %s--instead, current layout is %s.%s",
3315 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
3316 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel,
3317 string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
3318 formatted_label.c_str());
3319 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003320 }
3321 }
John Zulauff660ad62019-03-23 07:16:05 -06003322 }
3323
3324 // Update all layout set operations (which will be a subset of the initial_layouts
3325 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3326 VkImageLayout layout = (*it_set).layout;
3327 isr_pair.subresource = (*it_set).subresource;
3328 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003329 }
3330 }
John Zulauff660ad62019-03-23 07:16:05 -06003331
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003332 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003333}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003334
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003335void CoreChecks::UpdateCmdBufImageLayouts(CMD_BUFFER_STATE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003336 for (const auto &layout_map_entry : pCB->image_layout_map) {
3337 const auto image = layout_map_entry.first;
3338 const auto *image_state = GetImageState(image);
3339 if (!image_state) continue; // Can't set layouts of a dead image
3340 const auto &subres_map = layout_map_entry.second;
3341 ImageSubresourcePair isr_pair;
3342 isr_pair.image = image;
3343 isr_pair.hasSubresource = true;
3344
3345 // Update all layout set operations (which will be a subset of the initial_layouts
3346 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3347 VkImageLayout layout = (*it_set).layout;
3348 isr_pair.subresource = (*it_set).subresource;
3349 SetGlobalLayout(isr_pair, layout);
3350 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003351 }
3352}
3353
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003354// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003355// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3356// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003357bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3358 const VkImageLayout first_layout, const uint32_t attachment,
3359 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003360 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003361 const char *vuid;
3362 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3363
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003364 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3365 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003366 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3367 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3368 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003369 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003370 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3371 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3372 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3373 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3374 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3375 skip |=
3376 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3377 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003378 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003379 }
3380 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003381 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3382 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003383 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003384 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003385 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 -06003386 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003387 }
3388 }
3389
3390 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3391 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003392 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003393 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003394 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 -06003395 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003396 }
3397 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003398 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003399}
3400
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003401bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003402 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003403 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003404 const char *vuid;
3405 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3406 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003407
Jason Ekstranda1906302017-12-03 20:16:32 -08003408 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3409 VkFormat format = pCreateInfo->pAttachments[i].format;
3410 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3411 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3412 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003413 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 -06003414 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003415 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3416 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3417 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3418 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003419 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003420 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003421 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 -06003422 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003423 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3424 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3425 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3426 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003427 }
3428 }
3429 }
3430
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003431 // Track when we're observing the first use of an attachment
3432 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3433 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003434 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003435
3436 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3437 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3438 auto attach_index = subpass.pInputAttachments[j].attachment;
3439 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003440 switch (subpass.pInputAttachments[j].layout) {
3441 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3442 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3443 // These are ideal.
3444 break;
3445
3446 case VK_IMAGE_LAYOUT_GENERAL:
3447 // May not be optimal. TODO: reconsider this warning based on other constraints.
3448 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003449 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003450 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3451 break;
3452
Tobias Hectorbbb12282018-10-22 15:17:59 +01003453 case VK_IMAGE_LAYOUT_UNDEFINED:
3454 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3455 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3456 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3457 "Layout for input attachment reference %u in subpass %u is %s but must be "
3458 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3459 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3460 break;
3461
Graeme Leese668a9862018-10-08 10:40:02 +01003462 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3463 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003464 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003465 break;
3466 } else {
3467 // Intentionally fall through to generic error message
3468 }
3469 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003470
Cort Stratton7547f772017-05-04 15:18:52 -07003471 default:
3472 // No other layouts are acceptable
3473 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 -06003474 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003475 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3476 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3477 }
3478
Cort Stratton7547f772017-05-04 15:18:52 -07003479 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003480 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3481 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003482
3483 bool used_as_depth =
3484 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3485 bool used_as_color = false;
3486 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3487 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3488 }
3489 if (!used_as_depth && !used_as_color &&
3490 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003491 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3492 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3493 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3494 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003495 }
3496 }
3497 attach_first_use[attach_index] = false;
3498 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003499
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003500 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3501 auto attach_index = subpass.pColorAttachments[j].attachment;
3502 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3503
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003504 // TODO: Need a way to validate shared presentable images here, currently just allowing
3505 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3506 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003507 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003508 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003509 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003510 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3511 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003512 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003513
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003514 case VK_IMAGE_LAYOUT_GENERAL:
3515 // May not be optimal; TODO: reconsider this warning based on other constraints?
3516 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003517 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003518 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3519 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003520
Tobias Hectorbbb12282018-10-22 15:17:59 +01003521 case VK_IMAGE_LAYOUT_UNDEFINED:
3522 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3523 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3524 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3525 "Layout for color attachment reference %u in subpass %u is %s but should be "
3526 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3527 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3528 break;
3529
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003530 default:
3531 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 -06003532 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003533 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3534 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003535 }
3536
John Zulauf4eee2692019-02-09 16:14:25 -07003537 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3538 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3539 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003540 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3541 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 -07003542 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003543 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003544 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003545 }
3546
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003547 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003548 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3549 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003550 }
3551 attach_first_use[attach_index] = false;
3552 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003553
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003554 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3555 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003556 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3557 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3558 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003559 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003560
Dave Houltona9df0ce2018-02-07 10:51:23 -07003561 case VK_IMAGE_LAYOUT_GENERAL:
3562 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3563 // doing a bunch of transitions.
3564 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003565 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003566 "GENERAL layout for depth attachment may not give optimal performance.");
3567 break;
3568
Tobias Hectorbbb12282018-10-22 15:17:59 +01003569 case VK_IMAGE_LAYOUT_UNDEFINED:
3570 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3571 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3572 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3573 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3574 "layout or GENERAL.",
3575 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3576 break;
3577
Dave Houltona9df0ce2018-02-07 10:51:23 -07003578 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3579 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003580 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003581 break;
3582 } else {
3583 // Intentionally fall through to generic error message
3584 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003585 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003586
Dave Houltona9df0ce2018-02-07 10:51:23 -07003587 default:
3588 // No other layouts are acceptable
3589 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 -06003590 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003591 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3592 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3593 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003594 }
3595
3596 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3597 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003598 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3599 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003600 }
3601 attach_first_use[attach_index] = false;
3602 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003603 }
3604 return skip;
3605}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003606
3607// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskidb315cc2019-04-25 10:45:28 -06003608bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEMORY_STATE const *mem_info, VkDeviceSize offset,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003609 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003610 bool skip = false;
3611 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3612 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003613 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3614 for (auto image_handle : mem_info->bound_images) {
3615 auto img_it = mem_info->bound_ranges.find(image_handle);
3616 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003617 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003618 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003619 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003620 for (auto layout : layouts) {
3621 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003622 skip |=
3623 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_MEMORY_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003624 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003625 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3626 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003627 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003628 }
3629 }
3630 }
3631 }
3632 }
3633 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003634 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003635}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003636
3637// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3638// is true, verify that (actual & desired) flags == desired
John Zulauf4fea6622019-04-01 11:38:18 -06003639bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, const VulkanTypedHandle &typed_handle,
3640 const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003641 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003642 bool skip = false;
John Zulauf4fea6622019-04-01 11:38:18 -06003643 const char *type_str = object_string[typed_handle.type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003644 if (strict) {
3645 correct_usage = ((actual & desired) == desired);
3646 } else {
3647 correct_usage = ((actual & desired) != 0);
3648 }
3649 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003650 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003651 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
John Zulauf4fea6622019-04-01 11:38:18 -06003652 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type],
3653 typed_handle.handle, kVUID_Core_MemTrack_InvalidUsageFlag,
Lockee9aeebf2019-03-03 23:50:08 -07003654 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
John Zulauf4fea6622019-04-01 11:38:18 -06003655 type_str, report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003656 } else {
John Zulauf4fea6622019-04-01 11:38:18 -06003657 skip =
3658 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[typed_handle.type], typed_handle.handle,
3659 msgCode, "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3660 type_str, report_data->FormatHandle(typed_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003661 }
3662 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003663 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003664}
3665
3666// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3667// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003668bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
3669 char const *func_name, char const *usage_string) {
John Zulauf4fea6622019-04-01 11:38:18 -06003670 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict,
3671 VulkanTypedHandle(image_state->image, kVulkanObjectTypeImage), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003672}
3673
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003674bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003675 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003676 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003677 bool skip = false;
3678 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3679 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3681 HandleToUint64(image_state->image), linear_vuid,
3682 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3683 format_properties.linearTilingFeatures, image_state->createInfo.format,
3684 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003685 }
3686 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3687 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3689 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003690 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003691 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003692 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003693 }
3694 }
3695 return skip;
3696}
3697
Mark Lobodzinski33a34b82019-04-25 11:38:36 -06003698bool CoreChecks::ValidateImageSubresourceLayers(const CMD_BUFFER_STATE *cb_node, const VkImageSubresourceLayers *subresource_layers,
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003699 char const *func_name, char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003700 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003701 // layerCount must not be zero
3702 if (subresource_layers->layerCount == 0) {
3703 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3704 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3705 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3706 }
3707 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3708 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3709 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3710 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3711 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3712 }
3713 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3714 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3715 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3716 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3717 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3718 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3719 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3720 func_name, i, member);
3721 }
3722 return skip;
3723}
3724
Mark Lobodzinski96210742017-02-09 10:33:46 -07003725// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3726// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003727bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
3728 char const *func_name, char const *usage_string) {
John Zulauf4fea6622019-04-01 11:38:18 -06003729 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict,
3730 VulkanTypedHandle(buffer_state->buffer, kVulkanObjectTypeBuffer), msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003731}
3732
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003733bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3734 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003735 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003736
3737 const VkDeviceSize &range = pCreateInfo->range;
3738 if (range != VK_WHOLE_SIZE) {
3739 // Range must be greater than 0
3740 if (range <= 0) {
3741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3742 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3743 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3744 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3745 range);
3746 }
3747 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003748 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003749 if (range % format_size != 0) {
3750 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3751 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3752 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3753 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3754 "(" PRINTF_SIZE_T_SPECIFIER ").",
3755 range, format_size);
3756 }
3757 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3758 if (range / format_size > device_limits->maxTexelBufferElements) {
3759 skip |=
3760 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3761 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3762 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3763 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3764 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3765 range, format_size, device_limits->maxTexelBufferElements);
3766 }
3767 // The sum of range and offset must be less than or equal to the size of buffer
3768 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3769 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3770 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3771 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3772 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3773 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3774 range, pCreateInfo->offset, buffer_state->createInfo.size);
3775 }
3776 }
3777 return skip;
3778}
3779
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003780bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003781 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003782 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003783 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3784 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3785 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3786 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3787 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3788 "be supported for uniform texel buffers");
3789 }
3790 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3791 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3792 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3793 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3794 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3795 "be supported for storage texel buffers");
3796 }
3797 return skip;
3798}
3799
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003800bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3801 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003802 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003803
Dave Houltond8ed0212018-05-16 17:18:24 -06003804 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003805
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003806 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003807 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 -06003808 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003809 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003810 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003811 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003812
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003813 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003814 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 -06003815 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003816 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003817 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003818 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003819
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003820 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003821 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 -06003822 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003823 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003824 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003825 }
Jeff Bolz87697532019-01-11 22:54:00 -06003826
3827 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3828 if (chained_devaddr_struct) {
3829 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3830 chained_devaddr_struct->deviceAddress != 0) {
3831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3832 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3833 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3834 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3835 }
3836 }
3837
3838 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003839 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003840 skip |= log_msg(
3841 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3842 "VUID-VkBufferCreateInfo-flags-02605",
3843 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3844 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3845 }
3846
3847 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003848 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003849 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3850 "VUID-VkBufferCreateInfo-usage-02606",
3851 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3852 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3853 }
3854
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003855 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003856 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3857 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3858 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003859 }
3860
Mark Lobodzinski96210742017-02-09 10:33:46 -07003861 return skip;
3862}
3863
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003864void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3865 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003866 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003867 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06003868 bufferMap.insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003869}
3870
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003871bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3872 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003873 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003874 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003875 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3876 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003877 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003878 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3879 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003880 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003881 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3882 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3883 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003884
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003885 // Buffer view offset must be less than the size of buffer
3886 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3887 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3888 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3889 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3890 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3891 pCreateInfo->offset, buffer_state->createInfo.size);
3892 }
3893
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003894 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Shannon McPherson883f6092018-06-14 13:15:25 -06003895 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3896 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3897 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3898 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3899 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3900 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3901 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3902 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003903
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003904 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003905
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003906 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003907 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003908 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003909}
3910
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003911void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3912 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003913 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06003914 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003915}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003916
3917// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003918bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
3919 const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003920 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003921 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3922 if (image != VK_NULL_HANDLE) {
3923 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3924 }
3925
Dave Houlton1d2022c2017-03-29 11:43:58 -06003926 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003928 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003929 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003930 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003931 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003932 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003933 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003934 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003935 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003936 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003937 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003938 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3939 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003940 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003941 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003942 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003943 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3944 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003945 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003946 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003947 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003948 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003949 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003950 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003951 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003952 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003953 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003954 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003955 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003956 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003957 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003958 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003960 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003961 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003962 } else if (FormatIsMultiplane(format)) {
3963 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3964 if (3 == FormatPlaneCount(format)) {
3965 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3966 }
3967 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003968 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003969 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3970 "set, where n = [0, 1, 2].",
3971 func_name);
3972 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003973 }
3974 return skip;
3975}
3976
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003977bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
3978 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3979 const char *param_name, const char *image_layer_count_var_name,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003980 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003981 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003982
3983 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003984 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003985 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 -06003986 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003987 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003988 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3989 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003990 }
Petr Kraus4d718682017-05-18 03:38:41 +02003991
Petr Krausffa94af2017-08-08 21:46:02 +02003992 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3993 if (subresourceRange.levelCount == 0) {
3994 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 -06003995 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003996 } else {
3997 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003998
Petr Krausffa94af2017-08-08 21:46:02 +02003999 if (necessary_mip_count > image_mip_count) {
4000 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 -06004001 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004002 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004003 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004004 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004005 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004006 }
Petr Kraus4d718682017-05-18 03:38:41 +02004007 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004008 }
Petr Kraus4d718682017-05-18 03:38:41 +02004009
4010 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004011 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004012 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 -06004013 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004014 "%s: %s.baseArrayLayer (= %" PRIu32
4015 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4016 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004017 }
Petr Kraus4d718682017-05-18 03:38:41 +02004018
Petr Krausffa94af2017-08-08 21:46:02 +02004019 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4020 if (subresourceRange.layerCount == 0) {
4021 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 -06004022 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004023 } else {
4024 const uint64_t necessary_layer_count =
4025 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004026
Petr Krausffa94af2017-08-08 21:46:02 +02004027 if (necessary_layer_count > image_layer_count) {
4028 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 -06004029 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004030 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004031 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004032 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004033 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004034 }
Petr Kraus4d718682017-05-18 03:38:41 +02004035 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004036 }
Petr Kraus4d718682017-05-18 03:38:41 +02004037
Mark Lobodzinski602de982017-02-09 11:01:33 -07004038 return skip;
4039}
4040
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004041bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004042 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004043 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004044 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4045 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4046 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4047
4048 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4049 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4050
4051 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004052 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4053 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
Shannon McPherson5a0de262019-06-05 10:43:56 -06004054 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-02724"
Dave Houltond8ed0212018-05-16 17:18:24 -06004055 : "VUID-VkImageViewCreateInfo-image-01482")
4056 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4057 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
Shannon McPherson5a0de262019-06-05 10:43:56 -06004058 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-02725"
Dave Houltond8ed0212018-05-16 17:18:24 -06004059 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4060 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004061
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004062 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004063 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4064 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4065}
4066
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004067bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004068 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004069 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004070 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4071 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4072 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4073 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004074
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004075 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4076 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4077 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004078}
4079
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004080bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004081 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004082 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004083 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4084 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4085 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4086 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004087
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004088 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4089 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004090 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4091}
4092
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004093bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004094 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4095 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004096 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004097 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4098 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4099 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4100 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004101
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004102 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4103 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004104 subresourceRangeErrorCodes);
4105}
4106
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004107bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4108 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004109 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004110 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004111 if (image_state) {
4112 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004113 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004114 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004115 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4116 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004117 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004118 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004119 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004120 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004121 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004122 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004123 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004124 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004125
4126 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4127 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004128 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4129 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004130 VkFormat view_format = pCreateInfo->format;
4131 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004132 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004133 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004134
Dave Houltonbd2e2622018-04-10 16:41:14 -06004135 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004136 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004137 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004138 image_usage = chained_ivuci_struct->usage;
4139 }
4140
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004141 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4142 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004143 if (FormatIsMultiplane(image_format)) {
Graeme Leese605ca512019-05-08 12:59:44 +01004144 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, aspect_mask);
Dave Houltonc7988072018-04-16 11:46:56 -06004145 if (view_format != compat_format) {
Graeme Leese605ca512019-05-08 12:59:44 +01004146 // View format must match the multiplane compatible format
Lenny Komowb79f04a2017-09-18 17:07:00 -06004147 std::stringstream ss;
4148 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Graeme Leesed8572aa2019-05-15 14:58:19 +01004149 << " is not compatible with plane " << GetPlaneIndex(aspect_mask) << " of underlying image format "
Dave Houltonc7988072018-04-16 11:46:56 -06004150 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004151 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 -07004152 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004153 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004154 }
4155 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004156 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004157 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4158 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4159 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4160 std::stringstream ss;
4161 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004162 << " is not in the same format compatibility class as image ("
4163 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004164 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4165 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004166 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 -07004167 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004168 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004169 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004170 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004171 }
4172 } else {
4173 // Format MUST be IDENTICAL to the format the image was created with
4174 if (image_format != view_format) {
4175 std::stringstream ss;
4176 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004177 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004178 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004179 skip |=
4180 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004181 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004182 }
4183 }
4184
4185 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004186 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004187
4188 switch (image_type) {
4189 case VK_IMAGE_TYPE_1D:
4190 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004191 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 -07004192 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004193 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4194 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004195 }
4196 break;
4197 case VK_IMAGE_TYPE_2D:
4198 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4199 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4200 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004201 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 -07004202 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004203 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4204 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004205 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004206 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 -07004207 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004208 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4209 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004210 }
4211 }
4212 break;
4213 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004214 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004215 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4216 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4217 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004218 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004219 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004220 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004221 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4222 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004223 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4224 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004225 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004226 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004227 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004228 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4229 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004230 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4231 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004232 }
4233 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004234 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 -07004235 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004236 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4237 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004238 }
4239 }
4240 } else {
4241 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004242 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 -07004243 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004244 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4245 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004246 }
4247 }
4248 break;
4249 default:
4250 break;
4251 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004252
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004253 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004254 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004255 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004256 }
4257
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004258 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004259 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4260 : format_properties.optimalTilingFeatures;
4261
4262 if (tiling_features == 0) {
4263 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 -07004264 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004265 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4266 "physical device.",
4267 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4268 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4269 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 -07004270 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004271 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4272 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4273 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4274 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4275 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 -07004276 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004277 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4278 "VK_IMAGE_USAGE_STORAGE_BIT.",
4279 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4280 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4281 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4282 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-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004284 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4285 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4286 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4287 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4288 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4289 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 -07004290 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004291 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4292 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4293 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004294 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004295
Jeff Bolz9af91c52018-09-01 21:53:57 -05004296 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4297 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4298 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 -07004299 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004300 "vkCreateImageView() If image was created with usage containing "
4301 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4302 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4303 }
4304 if (view_format != VK_FORMAT_R8_UINT) {
4305 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 -07004306 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004307 "vkCreateImageView() If image was created with usage containing "
4308 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4309 }
4310 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004311 }
4312 return skip;
4313}
4314
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004315void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4316 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004317 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004318 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004319 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004320}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004321
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004322bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4323 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004324 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004325 auto src_buffer_state = GetBufferState(srcBuffer);
4326 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004327
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004328 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004329 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4330 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004331 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004332 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004333 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4334 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004335 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004336 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4337 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004338 skip |=
4339 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4340 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004341 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4342 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004343 return skip;
4344}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004345
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004346void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4347 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004348 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004349 auto src_buffer_state = GetBufferState(srcBuffer);
4350 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004351
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004352 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004353 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4354 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004355}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004356
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004357bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004358 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004359 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004360 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004361 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT, HandleToUint64(buffer),
Lockee9aeebf2019-03-03 23:50:08 -07004362 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4363 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004364 } else {
4365 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004366 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 -06004367 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004368 "Cannot free buffer %s that is in use by a command buffer.", report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004369 }
4370 }
4371 return skip;
4372}
4373
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004374bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004375 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
John Zulauf4fea6622019-04-01 11:38:18 -06004376 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004377
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004378 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004379 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004380 skip |=
4381 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004382 }
4383 return skip;
4384}
4385
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004386void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004387 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004388 if (!image_view_state) return;
John Zulauf4fea6622019-04-01 11:38:18 -06004389 const VulkanTypedHandle obj_struct(imageView, kVulkanObjectTypeImageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004390
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004391 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004392 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004393 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004394}
4395
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004396bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004397 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004398
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004399 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004400 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004401 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004402 }
4403 return skip;
4404}
4405
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004406void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004407 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004408 auto buffer_state = GetBufferState(buffer);
John Zulauf4fea6622019-04-01 11:38:18 -06004409 const VulkanTypedHandle obj_struct(buffer, kVulkanObjectTypeBuffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004410
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004411 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004412 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski0a41e0e2019-04-25 12:12:40 -06004413 auto mem_info = GetDevMemState(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004414 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004415 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004416 }
4417 }
John Zulauf4fea6622019-04-01 11:38:18 -06004418 ClearMemoryObjectBindings(obj_struct);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004419 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004420 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004421}
4422
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004423bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4424 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004425 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004426 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004427 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004428 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004429 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004430 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004431 }
4432 return skip;
4433}
4434
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004435void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004436 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004437 auto buffer_view_state = GetBufferViewState(bufferView);
John Zulauf4fea6622019-04-01 11:38:18 -06004438 const VulkanTypedHandle obj_struct(bufferView, kVulkanObjectTypeBufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004439
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004440 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004441 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004442 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004443}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004444
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004445bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4446 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004447 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004448 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004449 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004450 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004451 skip |=
4452 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4453 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004454 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004455 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004456 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4457 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004458 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004459 return skip;
4460}
4461
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004462void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4463 VkDeviceSize size, uint32_t data) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004464 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004465 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004466 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004467 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004468}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004469
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004470bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4471 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004472 bool skip = false;
4473
4474 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004475 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4476 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004477 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 -06004478 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004479 "%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 -06004480 "and 1, respectively.",
4481 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004482 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004483 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004484
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004485 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4486 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004487 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 -06004488 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004489 "%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 -06004490 "must be 0 and 1, respectively.",
4491 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004492 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004493 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004494
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004495 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4496 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004497 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 -06004498 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004499 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4500 "For 3D images these must be 0 and 1, respectively.",
4501 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004502 }
4503 }
4504
4505 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004506 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004507 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4508
Dave Houltona585d132019-01-18 13:05:42 -07004509 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004510 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 -06004511 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004512 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004513 " must be a multiple of this format's texel size (%" PRIu32 ").",
4514 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004515 }
4516
4517 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004518 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004519 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 -06004520 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004521 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4522 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004523 }
4524
4525 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4526 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004527 skip |=
4528 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004529 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004530 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4531 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004532 }
4533
4534 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4535 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4536 skip |= log_msg(
4537 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004538 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004539 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4540 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004541 }
4542
Mark Lobodzinskia8f6f5b2019-06-14 07:41:19 -06004543 // Calculate adjusted image extent, accounting for multiplane image factors
4544 VkExtent3D adusted_image_extent = GetImageSubresourceExtent(image_state, &pRegions[i].imageSubresource);
4545 // imageOffset.x and (imageExtent.width + imageOffset.x) must both be >= 0 and <= image subresource width
4546 if ((pRegions[i].imageOffset.x < 0) || (pRegions[i].imageOffset.x > static_cast<int32_t>(adusted_image_extent.width)) ||
4547 ((pRegions[i].imageOffset.x + pRegions[i].imageExtent.width) > static_cast<int32_t>(adusted_image_extent.width))) {
4548 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4549 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00197",
4550 "%s(): Both pRegion[%d] imageoffset.x (%d) and (imageExtent.width + imageOffset.x) (%d) must be >= "
4551 "zero or <= image subresource width (%d).",
4552 function, i, pRegions[i].imageOffset.x, (pRegions[i].imageOffset.x + pRegions[i].imageExtent.width),
4553 adusted_image_extent.width);
4554 }
4555
4556 // imageOffset.y and (imageExtent.height + imageOffset.y) must both be >= 0 and <= image subresource height
4557 if ((pRegions[i].imageOffset.y < 0) || (pRegions[i].imageOffset.y > static_cast<int32_t>(adusted_image_extent.height)) ||
4558 ((pRegions[i].imageOffset.y + pRegions[i].imageExtent.height) > static_cast<int32_t>(adusted_image_extent.height))) {
4559 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4560 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00198",
4561 "%s(): Both pRegion[%d] imageoffset.y (%d) and (imageExtent.height + imageOffset.y) (%d) must be >= "
4562 "zero or <= image subresource height (%d).",
4563 function, i, pRegions[i].imageOffset.y, (pRegions[i].imageOffset.y + pRegions[i].imageExtent.height),
4564 adusted_image_extent.height);
4565 }
4566
4567 // imageOffset.z and (imageExtent.depth + imageOffset.z) must both be >= 0 and <= image subresource depth
4568 if ((pRegions[i].imageOffset.z < 0) || (pRegions[i].imageOffset.z > static_cast<int32_t>(adusted_image_extent.depth)) ||
4569 ((pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth) > static_cast<int32_t>(adusted_image_extent.depth))) {
4570 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
4571 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00200",
4572 "%s(): Both pRegion[%d] imageoffset.z (%d) and (imageExtent.depth + imageOffset.z) (%d) must be >= "
4573 "zero or <= image subresource depth (%d).",
4574 function, i, pRegions[i].imageOffset.z, (pRegions[i].imageOffset.z + pRegions[i].imageExtent.depth),
4575 adusted_image_extent.depth);
4576 }
4577
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004578 // subresource aspectMask must have exactly 1 bit set
4579 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4580 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4581 if (aspect_mask_bits.count() != 1) {
4582 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 -06004583 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004584 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004585 }
4586
4587 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004588 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004589 skip |= log_msg(
4590 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004591 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004592 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4593 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004594 }
4595
4596 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004597 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004598 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004599
4600 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004601 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004602 skip |= log_msg(
4603 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004604 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004605 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4606 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004607 }
4608
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004609 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004610 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004611 skip |= log_msg(
4612 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004613 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004614 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4615 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004616 }
4617
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004618 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004619 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4620 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4621 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004622 skip |=
4623 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004624 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004625 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4626 "width & height (%d, %d)..",
4627 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004628 }
4629
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004630 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004631 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004632 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004633 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 -06004634 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004635 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004636 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004637 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004638 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004639
4640 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004641 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004642 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004643 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4644 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 -06004645 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004646 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004647 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004648 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004649 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004650 }
4651
4652 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004653 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004654 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4655 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 -06004656 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004657 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004658 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004659 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004660 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004661 }
4662
4663 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004664 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004665 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4666 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 -06004667 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004668 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004669 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004670 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004671 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004672 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004673 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004674 }
4675
4676 return skip;
4677}
4678
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004679static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004680 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004681 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004682 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004683
4684 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004685 VkExtent3D extent = pRegions[i].imageExtent;
4686 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004687
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004688 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4689 {
Dave Houlton51653902018-06-22 17:32:13 -06004690 skip |=
4691 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4692 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4693 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004694 }
4695
4696 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4697
4698 // 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 -06004699 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004700 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004701 if (image_extent.width % block_extent.width) {
4702 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4703 }
4704 if (image_extent.height % block_extent.height) {
4705 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4706 }
4707 if (image_extent.depth % block_extent.depth) {
4708 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4709 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004710 }
4711
Dave Houltonfc1a4052017-04-27 14:32:45 -06004712 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004713 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 -06004714 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004715 }
4716 }
4717
4718 return skip;
4719}
4720
Chris Forbese8ba09a2017-06-01 17:39:02 -07004721static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004722 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004723 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004724 bool skip = false;
4725
4726 VkDeviceSize buffer_size = buff_state->createInfo.size;
4727
4728 for (uint32_t i = 0; i < regionCount; i++) {
4729 VkExtent3D copy_extent = pRegions[i].imageExtent;
4730
4731 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4732 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004733 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4734 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004735
Tom Cooperb2550c72018-10-15 13:08:41 +01004736 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004737 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004738 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004739 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4740 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4741
4742 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4743 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4744 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004745 }
4746
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004747 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4748 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4749 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004750 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004751 } else {
4752 // Calculate buffer offset of final copied byte, + 1.
4753 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4754 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4755 max_buffer_offset *= unit_size; // convert to bytes
4756 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004757
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004758 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004759 skip |=
4760 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4761 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004762 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004763 }
4764 }
4765
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004766 return skip;
4767}
4768
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004769bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4770 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004771 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004772 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004773 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004774
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004775 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004776
4777 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004778 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004779
4780 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06004781 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004782
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004783 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004784
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004785 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4786 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 -06004787 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004788 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004789 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004790 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004791 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004792 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004793 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004794 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004795
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004796 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004797 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004798 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4799 skip |=
4800 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004801
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004802 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004803 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004804 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4805 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004806 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004807 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4808 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004809 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004810 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4811 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004812 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004813 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004814 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004815 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004816 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4817 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4818 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004819 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004820 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004821 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004822 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004823 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4824 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004825 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4826 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4827 skip |=
4828 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4829 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4830 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004831 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4832 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004833 }
4834 return skip;
4835}
4836
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004837void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4838 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004839 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004840 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004841 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004842
John Zulauff660ad62019-03-23 07:16:05 -06004843 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004844 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004845 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004846 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004847 // Update bindings between buffer/image and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004848 AddCommandBufferBindingImage(cb_node, src_image_state);
4849 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004850}
4851
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004852bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4853 VkImageLayout dstImageLayout, uint32_t regionCount,
4854 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004855 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004856 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004857 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004858
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004859 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004860
4861 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004862 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004863
4864 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinskic2a15b02019-04-25 12:06:02 -06004865 auto pPool = GetCommandPoolState(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004866 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004867 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4868 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 -06004869 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004870 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004871 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004872 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004873 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004874 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004875 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004876 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004877 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004878 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004879 skip |=
4880 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4881 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004882 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004883 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4884 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004885 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004886 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4887 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski544def72019-04-19 14:25:59 -06004888 if (api_version >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004889 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
4890 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004891 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004892 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004893 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004894 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004895 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4896 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4897 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004898 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004899 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07004900 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004901 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004902 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4903 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004904 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4905 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
4906 skip |=
4907 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
4908 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4909 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004910 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4911 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004912 }
4913 return skip;
4914}
4915
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004916void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4917 VkImageLayout dstImageLayout, uint32_t regionCount,
4918 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskicefe42f2019-04-25 12:16:27 -06004919 auto cb_node = GetCBState(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004920 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004921 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004922
John Zulauff660ad62019-03-23 07:16:05 -06004923 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004924 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004925 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004926 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004927 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4928 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004929}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004930
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004931bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4932 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004933 bool skip = false;
4934 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4935
Dave Houlton1d960ff2018-01-19 12:17:05 -07004936 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004937 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4938 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4939 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004940 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 -06004941 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004942 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004943 }
4944
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004945 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004946 if (!image_entry) {
4947 return skip;
4948 }
4949
Dave Houlton1d960ff2018-01-19 12:17:05 -07004950 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004951 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004952 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4953 "VUID-vkGetImageSubresourceLayout-image-00996",
4954 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004955 }
4956
Dave Houlton1d960ff2018-01-19 12:17:05 -07004957 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004958 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004959 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4960 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4961 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4962 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004963 }
4964
Dave Houlton1d960ff2018-01-19 12:17:05 -07004965 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004966 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004967 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4968 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4969 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4970 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004971 }
4972
Dave Houlton1d960ff2018-01-19 12:17:05 -07004973 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004974 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004975 if (FormatIsMultiplane(img_format)) {
4976 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004977 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004978 if (FormatPlaneCount(img_format) > 2u) {
4979 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004980 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004981 }
4982 if (sub_aspect != (sub_aspect & allowed_flags)) {
4983 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 -06004984 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004985 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004986 ") must be a single-plane specifier flag.",
4987 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004988 }
4989 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004990 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004991 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004992 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004993 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004994 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004995 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004996 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004997 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004998 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 -06004999 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005000 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005001 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005002 }
5003 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005004
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06005005 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07005006 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005007 }
5008
Mike Weiblen672b58b2017-02-21 14:32:53 -07005009 return skip;
5010}