blob: 0095d34003eeb76b12b0780d23089b50ed54c738 [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);
89}
90
91IMAGE_VIEW_STATE::IMAGE_VIEW_STATE(const IMAGE_STATE *image_state, VkImageView iv, const VkImageViewCreateInfo *ci)
92 : image_view(iv), create_info(*ci), normalized_subresource_range(ci->subresourceRange), samplerConversion(VK_NULL_HANDLE) {
93 auto *conversionInfo = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info.pNext);
94 if (conversionInfo) samplerConversion = conversionInfo->conversion;
95 if (image_state) {
96 // A light normalization of the createInfo range
97 auto &sub_res_range = create_info.subresourceRange;
98 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
99 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
100
101 // Cache a full normalization (for "full image/whole image" comparisons)
102 normalized_subresource_range = NormalizeSubresourceRange(*image_state, ci->subresourceRange);
103 }
104}
105
Dave Houltond9611312018-11-19 17:03:36 -0700106uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
107 // uint cast applies floor()
108 return 1u + (uint32_t)log2(std::max({height, width, depth}));
109}
110
111uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
112
113uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
114
John Zulauff660ad62019-03-23 07:16:05 -0600115VkImageSubresourceRange NormalizeSubresourceRange(const IMAGE_STATE &image_state, const VkImageSubresourceRange &range) {
116 const VkImageCreateInfo &image_create_info = image_state.createInfo;
117 VkImageSubresourceRange norm = range;
118 norm.levelCount = ResolveRemainingLevels(&range, image_create_info.mipLevels);
119
120 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
121 // <arrayLayers> can potentially alias.
122 uint32_t layer_limit = (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR))
123 ? image_create_info.extent.depth
124 : image_create_info.arrayLayers;
125 norm.layerCount = ResolveRemainingLayers(&range, layer_limit);
126
127 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
128 VkImageAspectFlags &aspect_mask = norm.aspectMask;
129 if (FormatIsMultiplane(image_create_info.format)) {
130 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
131 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
132 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
133 if (FormatPlaneCount(image_create_info.format) > 2) {
134 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
135 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700136 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700137 }
John Zulauff660ad62019-03-23 07:16:05 -0600138 return norm;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700139}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700140
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700141template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700142void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700143 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700144 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
145 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
146 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
147 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700148 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700149 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
150 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
151 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700152 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700153}
154
155template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700156void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700157 if (imgpair.subresource.aspectMask & aspectMask) {
158 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700159 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700160 }
161}
162
Tony Barbourdf013b92017-01-25 12:53:48 -0700163// Set the layout in supplied map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700164void CoreChecks::SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
165 ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700166 auto it = imageLayoutMap.find(imgpair);
167 if (it != imageLayoutMap.end()) {
168 it->second.layout = layout; // Update
169 } else {
170 imageLayoutMap[imgpair].layout = layout; // Insert
171 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700172}
173
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700174bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700175 if (!(imgpair.subresource.aspectMask & aspectMask)) {
176 return false;
177 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700178 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
179 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700180 auto imgsubIt = (*GetImageLayoutMap()).find(imgpair);
181 if (imgsubIt == (*GetImageLayoutMap()).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700182 return false;
183 }
184 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200185 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 -0600186 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700187 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
188 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700189 string_VkImageLayout(imgsubIt->second.layout));
190 }
191 layout = imgsubIt->second.layout;
192 return true;
193}
194
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700195// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700196bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700197 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700198 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
199 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
200 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
201 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700202 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700203 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
204 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
205 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700206 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700207 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
208 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700209 auto imgsubIt = (*GetImageLayoutMap()).find(imgpair);
210 if (imgsubIt == (*GetImageLayoutMap()).end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700211 layout = imgsubIt->second.layout;
212 }
213 return true;
214}
215
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700216bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700217 auto sub_data = (*GetImageSubresourceMap()).find(image);
218 if (sub_data == (*GetImageSubresourceMap()).end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700219 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700220 if (!image_state) return false;
221 bool ignoreGlobal = false;
222 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
223 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
224 ignoreGlobal = true;
225 }
226 for (auto imgsubpair : sub_data->second) {
227 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700228 auto img_data = (*GetImageLayoutMap()).find(imgsubpair);
229 if (img_data != (*GetImageLayoutMap()).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700230 layouts.push_back(img_data->second.layout);
231 }
232 }
233 return true;
234}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700235
236bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
237 ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700238 if (!(imgpair.subresource.aspectMask & aspectMask)) {
239 return false;
240 }
241 imgpair.subresource.aspectMask = aspectMask;
242 auto imgsubIt = imageLayoutMap.find(imgpair);
243 if (imgsubIt == imageLayoutMap.end()) {
244 return false;
245 }
246 layout = imgsubIt->second.layout;
247 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700248}
Tony Barbourdf013b92017-01-25 12:53:48 -0700249
250// find layout in supplied map
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700251bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700252 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700253 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
254 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
255 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
256 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
257 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700258 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700259 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
260 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
261 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
262 }
263 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700264 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
265 imgpair = {imgpair.image, false, VkImageSubresource()};
266 auto imgsubIt = imageLayoutMap.find(imgpair);
267 if (imgsubIt == imageLayoutMap.end()) return false;
268 layout = imgsubIt->second.layout;
269 }
270 return true;
271}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700272
273// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700274void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700275 VkImage &image = imgpair.image;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700276 auto &lmap = (*GetImageLayoutMap());
Dave Houltonb3f4b282018-02-22 16:25:16 -0700277 auto data = lmap.find(imgpair);
278 if (data != lmap.end()) {
279 data->second.layout = layout; // Update
280 } else {
281 lmap[imgpair].layout = layout; // Insert
282 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700283 auto &image_subresources = (*GetImageSubresourceMap())[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700284 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
285 if (subresource == image_subresources.end()) {
286 image_subresources.push_back(imgpair);
287 }
288}
289
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600290// Set image layout for given VkImageSubresourceRange struct
John Zulauff660ad62019-03-23 07:16:05 -0600291void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
292 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
293 VkImageLayout expected_layout) {
294 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
295 assert(subresource_map); // the non-const getter must return a valid pointer
296 if (subresource_map->SetSubresourceRangeLayout(image_subresource_range, layout, expected_layout)) {
297 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700298 }
299}
John Zulauff660ad62019-03-23 07:16:05 -0600300
301// Set the initial image layout for all slices of an image view
302void CoreChecks::SetImageViewInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
303 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
304 if (image_state) {
305 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
306 subresource_map->SetSubresourceRangeInitialLayout(view_state.normalized_subresource_range, layout);
307 }
308}
309
310// Set the initial image layout for a passed non-normalized subresource range
311void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
312 const VkImageSubresourceRange &range, VkImageLayout layout) {
313 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
314 assert(subresource_map);
315 subresource_map->SetSubresourceRangeInitialLayout(NormalizeSubresourceRange(image_state, range), layout);
316}
317
318void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, VkImage image, const VkImageSubresourceRange &range,
319 VkImageLayout layout) {
320 const IMAGE_STATE *image_state = GetImageState(image);
321 if (!image_state) return;
322 SetImageInitialLayout(cb_node, *image_state, range, layout);
323};
324
325void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
326 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
327 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600328}
Dave Houltonddd65c52018-05-08 14:58:01 -0600329
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600330// Set image layout for all slices of an image view
John Zulauff660ad62019-03-23 07:16:05 -0600331void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
332 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
333 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600334
John Zulauff660ad62019-03-23 07:16:05 -0600335 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600336 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
337 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600338 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 -0600339 sub_range.baseArrayLayer = 0;
340 sub_range.layerCount = image_state->createInfo.extent.depth;
341 }
342
John Zulauff660ad62019-03-23 07:16:05 -0600343 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600344}
345
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700346bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
347 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700348 VkFramebuffer framebuffer, VkRenderPass renderpass,
349 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100350 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700351 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100352 const char *vuid;
353 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
354
355 if (!image_state) {
356 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
357 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700358 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
359 "] = image view %s, which refers to an invalid image",
360 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
361 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100362 return skip;
363 }
364
365 auto image_usage = image_state->createInfo.usage;
366
367 // Check for layouts that mismatch image usages in the framebuffer
368 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
369 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
370 skip |=
371 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 -0700372 "Layout/usage mismatch for attachment %u in render pass %s"
373 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100374 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600375 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
376 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 }
378
379 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
380 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
381 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
382 skip |=
383 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 -0700384 "Layout/usage mismatch for attachment %u in render pass %s"
385 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600387 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
388 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100389 }
390
391 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
392 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
393 skip |=
394 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 -0700395 "Layout/usage mismatch for attachment %u in render pass %s"
396 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100397 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600398 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
399 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 }
401
402 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
403 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
404 skip |=
405 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 -0700406 "Layout/usage mismatch for attachment %u in render pass %s"
407 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100408 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600409 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
410 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100411 }
412
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700413 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
415 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
416 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
417 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
418 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700420 skip |= log_msg(
421 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
422 "Layout/usage mismatch for attachment %u in render pass %s"
423 " - the %s is %s but the image attached to framebuffer %s via image view %s"
424 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600425 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
426 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 }
428 } else {
429 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
430 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
432 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
434 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700435 "Layout/usage mismatch for attachment %u in render pass %s"
436 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100437 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600438 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
439 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700440 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 }
442 }
443 return skip;
444}
445
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700446bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
447 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700448 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600449 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700450 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700451 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700453 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454 auto framebuffer = framebuffer_state->framebuffer;
455
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700456 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600457 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 -0600458 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700459 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 }
John Zulauff660ad62019-03-23 07:16:05 -0600461 const auto *const_pCB = static_cast<const GLOBAL_CB_NODE *>(pCB);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700462 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
463 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700464 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600465
466 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700467 skip |=
468 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
469 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
470 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
471 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
472 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600473 continue;
474 }
475
John Zulauff660ad62019-03-23 07:16:05 -0600476 const VkImage image = view_state->create_info.image;
477 const IMAGE_STATE *image_state = GetImageState(image);
478
479 if (!image_state) {
480 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
481 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
482 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32
483 "] = VkImageView %s references non-extant VkImage %s.",
484 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
485 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
486 continue;
487 }
488 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100489 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
490
John Zulauff660ad62019-03-23 07:16:05 -0600491 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
492 // in common with the non-const version.)
493 const ImageSubresourceLayoutMap *subresource_map =
494 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
495
496 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
497 bool subres_skip = false;
498 auto subresource_cb = [this, i, attachment_initial_layout, &subres_skip](
499 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
500 LayoutUseCheckAndMessage layout_check(attachment_initial_layout, layout, initial_layout);
501 if (layout_check.CheckFailed()) {
502 subres_skip |=
503 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
504 kVUID_Core_DrawState_InvalidRenderpass,
505 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
506 "and the %s layout of the attachment is %s. The layouts must match, or the render "
507 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
508 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
509 string_VkImageLayout(layout_check.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700510 }
John Zulauff660ad62019-03-23 07:16:05 -0600511 return !subres_skip; // quit checking subresources once we fail once
512 };
513
514 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
515 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700516 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100517
John Zulauff660ad62019-03-23 07:16:05 -0600518 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view, framebuffer,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700519 render_pass, i, "initial layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100520
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700521 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer, render_pass,
522 i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100523 }
524
525 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
526 auto &subpass = pRenderPassInfo->pSubpasses[j];
527 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
528 auto &attachment_ref = subpass.pInputAttachments[k];
529 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
530 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700531 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100532
533 if (view_state) {
534 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700535 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
536 framebuffer, render_pass, attachment_ref.attachment,
537 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100538 }
539 }
540 }
541
542 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
543 auto &attachment_ref = subpass.pColorAttachments[k];
544 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
545 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700546 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100547
548 if (view_state) {
549 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700550 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
551 framebuffer, render_pass, attachment_ref.attachment,
552 "color attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100553 if (subpass.pResolveAttachments) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700554 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
555 framebuffer, render_pass, attachment_ref.attachment,
556 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100557 }
558 }
559 }
560 }
561
562 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
563 auto &attachment_ref = *subpass.pDepthStencilAttachment;
564 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
565 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700566 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100567
568 if (view_state) {
569 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700570 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
571 framebuffer, render_pass, attachment_ref.attachment,
572 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100573 }
574 }
575 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700576 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600577 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700578}
579
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700580void CoreChecks::TransitionAttachmentRefLayout(GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700581 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700582 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700583 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600584 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600585 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600586 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700587 }
588}
589
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700590void CoreChecks::TransitionSubpassLayouts(GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state, const int subpass_index,
591 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700592 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700593
594 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700595 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700596 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700597 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700598 }
599 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700600 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700601 }
602 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700603 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700604 }
605 }
606}
607
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700608// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
609// 1. Transition into initialLayout state
610// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700611void CoreChecks::TransitionBeginRenderPassLayouts(GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700612 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700613 // First transition into initialLayout
614 auto const rpci = render_pass_state->createInfo.ptr();
615 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700616 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600617 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600618 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600619 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700620 }
621 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700622 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700623}
624
Dave Houlton10b39482017-03-16 13:18:15 -0600625bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600626 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600627 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600628 }
629 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600630 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600631 }
632 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600633 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600634 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700635 if (0 !=
636 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
637 if (FormatPlaneCount(format) == 1) return false;
638 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600639 return true;
640}
641
Mike Weiblen62d08a32017-03-07 22:18:27 -0700642// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700643bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier *img_barrier, bool new_not_old,
644 VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700645 bool skip = false;
646 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600647 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700648
649 switch (layout) {
650 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
651 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600652 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700653 }
654 break;
655 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
656 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600657 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700658 }
659 break;
660 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
661 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600662 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700663 }
664 break;
665 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
666 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600667 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700668 }
669 break;
670 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
671 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600672 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700673 }
674 break;
675 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
676 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600677 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700678 }
679 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600680 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500681 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
682 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
683 }
684 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700685 default:
686 // Other VkImageLayout values do not have VUs defined in this context.
687 break;
688 }
689
Dave Houlton8e9f6542018-05-18 12:18:22 -0600690 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600691 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 -0600692 HandleToUint64(img_barrier->image), msg_code,
John Zulauff660ad62019-03-23 07:16:05 -0600693 "%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 -0700694 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
695 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700696 }
697 return skip;
698}
699
John Zulauf463c51e2018-05-31 13:29:20 -0600700// Scoreboard for checking for duplicate and inconsistent barriers to images
701struct ImageBarrierScoreboardEntry {
702 uint32_t index;
703 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
704 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
705 const VkImageMemoryBarrier *barrier;
706};
707using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
708using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
709
Mike Weiblen62d08a32017-03-07 22:18:27 -0700710// Verify image barriers are compatible with the images they reference.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700711bool CoreChecks::ValidateBarriersToImages(GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700712 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700713 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700714
John Zulauf463c51e2018-05-31 13:29:20 -0600715 // Scoreboard for duplicate layout transition barriers within the list
716 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
717 ImageBarrierScoreboardImageMap layout_transitions;
718
Mike Weiblen62d08a32017-03-07 22:18:27 -0700719 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
720 auto img_barrier = &pImageMemoryBarriers[i];
721 if (!img_barrier) continue;
722
John Zulauf463c51e2018-05-31 13:29:20 -0600723 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
724 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
725 // at a per sub-resource level
726 if (img_barrier->oldLayout != img_barrier->newLayout) {
727 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
728 auto image_it = layout_transitions.find(img_barrier->image);
729 if (image_it != layout_transitions.end()) {
730 auto &subres_map = image_it->second;
731 auto subres_it = subres_map.find(img_barrier->subresourceRange);
732 if (subres_it != subres_map.end()) {
733 auto &entry = subres_it->second;
734 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
735 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
736 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
737 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700738 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
739 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700740 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600741 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
742 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700743 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700744 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
745 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600746 }
747 entry = new_entry;
748 } else {
749 subres_map[img_barrier->subresourceRange] = new_entry;
750 }
751 } else {
752 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
753 }
754 }
755
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700756 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600757 if (image_state) {
758 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700759 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name);
760 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600761
762 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
763 if (image_state->layout_locked) {
764 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600765 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700766 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
767 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700768 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600769 " 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 -0700770 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
771 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600772 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600773
John Zulauff660ad62019-03-23 07:16:05 -0600774 VkImageCreateInfo *image_create_info = &image_state->createInfo;
775 // For a Depth/Stencil image both aspects MUST be set
776 if (FormatIsDepthAndStencil(image_create_info->format)) {
777 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
778 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
779 if ((aspect_mask & ds_mask) != (ds_mask)) {
780 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
781 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
782 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
783 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
784 func_name, static_cast<const void *>(img_barrier),
785 report_data->FormatHandle(img_barrier->image).c_str(),
786 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700787 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700788 }
John Zulauff660ad62019-03-23 07:16:05 -0600789
790 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier->image);
791 if (img_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
792 // TODO: Set memory invalid which is in mem_tracker currently
793 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
794 // subresource.
795 } else if (subresource_map) {
796 bool subres_skip = false;
797 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier->subresourceRange);
798 auto subres_callback = [this, img_barrier, cb_state, &subres_skip](
799 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
800 LayoutUseCheckAndMessage layout_check(img_barrier->oldLayout, layout, initial_layout);
801 if (layout_check.CheckFailed()) {
802 subres_skip =
803 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
804 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
805 "For image %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
806 "%s layout is %s.",
807 report_data->FormatHandle(img_barrier->image).c_str(), subres.aspectMask, subres.mipLevel,
808 subres.arrayLayer, string_VkImageLayout(img_barrier->oldLayout), layout_check.message,
809 string_VkImageLayout(layout_check.layout));
810 }
811 return !subres_skip;
812 };
813 subresource_map->ForRange(normalized_isr, subres_callback);
814 skip |= subres_skip;
815 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700816 }
817 }
818 return skip;
819}
820
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700821bool CoreChecks::IsReleaseOp(GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600822 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700823
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700824 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700825 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700826}
827
John Zulauf6b4aae82018-05-09 13:03:36 -0600828template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700829bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
830 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600831 using BarrierRecord = QFOTransferBarrier<Barrier>;
832 bool skip = false;
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700833 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600834 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
835 const char *barrier_name = BarrierRecord::BarrierName();
836 const char *handle_name = BarrierRecord::HandleName();
837 const char *transfer_type = nullptr;
838 for (uint32_t b = 0; b < barrier_count; b++) {
839 if (!IsTransferOp(&barriers[b])) continue;
840 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700841 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
842 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600843 const auto found = barrier_sets.release.find(barriers[b]);
844 if (found != barrier_sets.release.cend()) {
845 barrier_record = &(*found);
846 transfer_type = "releasing";
847 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600848 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
849 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600850 const auto found = barrier_sets.acquire.find(barriers[b]);
851 if (found != barrier_sets.acquire.cend()) {
852 barrier_record = &(*found);
853 transfer_type = "acquiring";
854 }
855 }
856 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700857 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
858 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
859 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
860 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
861 func_name, barrier_name, b, transfer_type, handle_name,
862 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
863 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600864 }
865 }
866 return skip;
867}
868
869template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700870void CoreChecks::RecordQFOTransferBarriers(GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700871 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600872 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
873 for (uint32_t b = 0; b < barrier_count; b++) {
874 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700875 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
876 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600877 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600878 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
879 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600880 barrier_sets.acquire.emplace(barriers[b]);
881 }
882 }
883}
884
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700885bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
886 const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700887 uint32_t imageMemBarrierCount,
888 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600889 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700890 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
891 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600892 return skip;
893}
894
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700895void CoreChecks::RecordBarriersQFOTransfers(GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700896 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
897 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700898 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
899 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600900}
901
902template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700903bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
904 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600905 // Record to the scoreboard or report that we have a duplication
906 bool skip = false;
907 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
908 if (!inserted.second && inserted.first->second != cb_state) {
909 // 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 -0700910 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
911 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
912 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
913 " duplicates existing barrier submitted in this batch from command buffer %s.",
914 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
915 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
916 report_data->FormatHandle(inserted.first->second).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600917 }
918 return skip;
919}
920
921template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700922bool CoreChecks::ValidateQueuedQFOTransferBarriers(GLOBAL_CB_NODE *cb_state, QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600923 using BarrierRecord = QFOTransferBarrier<Barrier>;
924 using TypeTag = typename BarrierRecord::Tag;
925 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600926 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700927 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600928 const char *barrier_name = BarrierRecord::BarrierName();
929 const char *handle_name = BarrierRecord::HandleName();
930 // No release should have an extant duplicate (WARNING)
931 for (const auto &release : cb_barriers.release) {
932 // Check the global pending release barriers
933 const auto set_it = global_release_barriers.find(release.handle);
934 if (set_it != global_release_barriers.cend()) {
935 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
936 const auto found = set_for_handle.find(release);
937 if (found != set_for_handle.cend()) {
938 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
939 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700940 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600941 " to dstQueueFamilyIndex %" PRIu32
942 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700943 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600944 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
945 }
946 }
947 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
948 }
949 // Each acquire must have a matching release (ERROR)
950 for (const auto &acquire : cb_barriers.acquire) {
951 const auto set_it = global_release_barriers.find(acquire.handle);
952 bool matching_release_found = false;
953 if (set_it != global_release_barriers.cend()) {
954 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
955 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
956 }
957 if (!matching_release_found) {
958 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
959 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700960 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
961 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
962 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600963 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
964 }
965 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
966 }
967 return skip;
968}
969
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700970bool CoreChecks::ValidateQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700971 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
972 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600973 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700974 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
975 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600976 return skip;
977}
978
979template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700980void CoreChecks::RecordQueuedQFOTransferBarriers(GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600981 using BarrierRecord = QFOTransferBarrier<Barrier>;
982 using TypeTag = typename BarrierRecord::Tag;
983 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700984 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600985
986 // Add release barriers from this submit to the global map
987 for (const auto &release : cb_barriers.release) {
988 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
989 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
990 global_release_barriers[release.handle].insert(release);
991 }
992
993 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
994 for (const auto &acquire : cb_barriers.acquire) {
995 // NOTE: We're not using [] because we don't want to create entries for missing releases
996 auto set_it = global_release_barriers.find(acquire.handle);
997 if (set_it != global_release_barriers.end()) {
998 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
999 set_for_handle.erase(acquire);
1000 if (set_for_handle.size() == 0) { // Clean up empty sets
1001 global_release_barriers.erase(set_it);
1002 }
1003 }
1004 }
1005}
1006
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001007void CoreChecks::RecordQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state) {
1008 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1009 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001010}
1011
John Zulauf6b4aae82018-05-09 13:03:36 -06001012// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001013void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001014
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001015void CoreChecks::TransitionImageLayouts(GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001016 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001017 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1018 auto mem_barrier = &pImgMemBarriers[i];
1019 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001020
Chris Forbes4de4b132017-08-21 11:27:08 -07001021 // For ownership transfers, the barrier is specified twice; as a release
1022 // operation on the yielding queue family, and as an acquire operation
1023 // on the acquiring queue family. This barrier may also include a layout
1024 // transition, which occurs 'between' the two operations. For validation
1025 // purposes it doesn't seem important which side performs the layout
1026 // transition, but it must not be performed twice. We'll arbitrarily
1027 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001028 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001029 continue;
1030 }
1031
John Zulauff660ad62019-03-23 07:16:05 -06001032 auto *image_state = GetImageState(mem_barrier->image);
1033 if (!image_state) continue;
1034
1035 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier->subresourceRange);
1036 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001037
Dave Houltonb3f4b282018-02-22 16:25:16 -07001038 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1039 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1040 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001041 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1042 normalized_isr.baseArrayLayer = 0;
1043 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001044 }
1045
John Zulauff660ad62019-03-23 07:16:05 -06001046 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier->newLayout, mem_barrier->oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001047 }
1048}
1049
John Zulauff660ad62019-03-23 07:16:05 -06001050bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001051 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1052 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) {
John Zulauff660ad62019-03-23 07:16:05 -06001053 assert(cb_node);
1054 assert(image_state);
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001055 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001056 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001057
John Zulauff660ad62019-03-23 07:16:05 -06001058 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image);
1059 if (subresource_map) {
1060 bool subres_skip = false;
1061 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, &error, &subres_skip](
1062 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
1063 LayoutUseCheckAndMessage layout_check(explicit_layout, layout, initial_layout);
1064 if (layout_check.CheckFailed()) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001065 *error = true;
John Zulauff660ad62019-03-23 07:16:05 -06001066 subres_skip |=
1067 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1068 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
1069 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the "
1070 "%s layout %s.",
1071 caller, report_data->FormatHandle(image).c_str(), subres.arrayLayer, subres.mipLevel,
1072 string_VkImageLayout(explicit_layout), layout_check.message, string_VkImageLayout(layout_check.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001073 }
John Zulauff660ad62019-03-23 07:16:05 -06001074 return !subres_skip;
1075 };
1076 subresource_map->ForRange(range, subresource_cb);
1077 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001078 }
John Zulauff660ad62019-03-23 07:16:05 -06001079
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001080 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1081 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1082 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001083 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1084 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001085 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001086 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001087 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001088 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1089 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001090 }
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001091 } else if (GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001092 if (image_state->shared_presentable) {
1093 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001094 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1095 layout_invalid_msg_code,
1096 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1097 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001098 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001099 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001100 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001101 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001102 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 -07001103 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001104 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1105 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1106 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001107 }
1108 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001109 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001110}
John Zulauff660ad62019-03-23 07:16:05 -06001111bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
1112 const VkImageSubresourceLayers &subLayers, VkImageLayout explicit_layout,
1113 VkImageLayout optimal_layout, const char *caller, const char *layout_invalid_msg_code,
1114 const char *layout_mismatch_msg_code, bool *error) {
1115 return VerifyImageLayout(cb_node, image_state, RangeFromLayers(subLayers), explicit_layout, optimal_layout, caller,
1116 layout_invalid_msg_code, layout_mismatch_msg_code, error);
1117}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001118
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001119void CoreChecks::TransitionFinalSubpassLayouts(GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001120 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001121 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001122 if (!renderPass) return;
1123
Tobias Hectorbbb12282018-10-22 15:17:59 +01001124 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001125 if (framebuffer_state) {
1126 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001127 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001128 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -06001129 SetImageViewLayout(pCB, *view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001130 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001131 }
1132 }
1133}
Dave Houltone19e20d2018-02-02 16:32:41 -07001134
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001135#ifdef VK_USE_PLATFORM_ANDROID_KHR
1136// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1137// This could also move into a seperate core_validation_android.cpp file... ?
1138
1139//
1140// AHB-specific validation within non-AHB APIs
1141//
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001142bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001143 bool skip = false;
1144
1145 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1146 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001147 if (0 != ext_fmt_android->externalFormat) {
1148 if (VK_FORMAT_UNDEFINED != create_info->format) {
1149 skip |=
1150 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1151 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001152 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001153 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1154 }
1155
1156 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1157 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1158 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001159 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001160 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1161 }
1162
1163 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1164 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1165 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001166 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001167 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1168 }
1169
1170 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1171 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1172 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001173 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001174 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1175 }
1176 }
1177
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001178 auto ahb_formats = GetAHBExternalFormatsSet();
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001179 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1180 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1181 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001182 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001183 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1184 }
1185 }
1186
Dave Houltond9611312018-11-19 17:03:36 -07001187 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001188 if (VK_FORMAT_UNDEFINED == create_info->format) {
1189 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1190 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001191 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001192 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1193 }
1194 }
1195
1196 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1197 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1198 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001199 skip |=
1200 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1201 "VUID-VkImageCreateInfo-pNext-02393",
1202 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1203 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1204 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001205 }
1206
1207 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1208 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1209 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001210 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001211 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1212 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1213 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1214 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001215 }
1216
1217 return skip;
1218}
1219
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001220void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001221 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1222 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1223 is_node->imported_ahb = true;
1224 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001225 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001226 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001227 is_node->has_ahb_format = true;
1228 is_node->ahb_format = ext_fmt_android->externalFormat;
1229 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001230}
1231
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001232bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001233 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001234 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001235
1236 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001237 if (VK_FORMAT_UNDEFINED != create_info->format) {
1238 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1239 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1240 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1241 "format member is %s.",
1242 string_VkFormat(create_info->format));
1243 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001244
Dave Houltond9611312018-11-19 17:03:36 -07001245 // Chain must include a compatible ycbcr conversion
1246 bool conv_found = false;
1247 uint64_t external_format = 0;
1248 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1249 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001250 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001251 auto fmap = GetYcbcrConversionFormatMap();
Dave Houltond9611312018-11-19 17:03:36 -07001252 if (fmap->find(conv_handle) != fmap->end()) {
1253 conv_found = true;
1254 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001255 }
Dave Houltond9611312018-11-19 17:03:36 -07001256 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001257 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001258 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 -07001259 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1260 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1261 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1262 }
1263
1264 // Errors in create_info swizzles
1265 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1266 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1267 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1268 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1269 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1270 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1271 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1272 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001273 }
1274 }
Dave Houltond9611312018-11-19 17:03:36 -07001275
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001276 return skip;
1277}
1278
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001279bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001280 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001282 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001283 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1284 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1285 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001286 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001287 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1288 "bound to memory.");
1289 }
1290 return skip;
1291}
1292
1293#else
1294
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001295bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001296 return false;
1297}
1298
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001299void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001301bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001303bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001304
1305#endif // VK_USE_PLATFORM_ANDROID_KHR
1306
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001307bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1308 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001309 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001310
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001311 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001312 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001313 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1314 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1315 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1316 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001317 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001318 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001319 }
1320
Dave Houlton130c0212018-01-29 13:39:56 -07001321 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001322 skip |= log_msg(
1323 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1324 "VUID-VkImageCreateInfo-flags-00949",
1325 "vkCreateImage(): Image type must be VK_IMAGE_TYPE_2D when VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT flag bit is set");
Dave Houlton130c0212018-01-29 13:39:56 -07001326 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001327
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001328 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001329 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1330 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1331 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001332 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 +00001333 "VUID-VkImageCreateInfo-usage-00964",
1334 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1335 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001336 }
1337
1338 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001339 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 +00001340 "VUID-VkImageCreateInfo-usage-00965",
1341 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1342 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001343 }
1344
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001346 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001347 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1348 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1349 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1350 string_VkFormat(pCreateInfo->format));
1351 } else {
1352 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1353 const char *format_string = string_VkFormat(pCreateInfo->format);
1354 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1355 "VUID-VkImageCreateInfo-mipLevels-02255",
1356 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1357 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1358 }
Dave Houlton130c0212018-01-29 13:39:56 -07001359
Dave Houltona585d132019-01-18 13:05:42 -07001360 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1361 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1362 (uint64_t)pCreateInfo->samples;
1363 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001364
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001365 // Round up to imageGranularity boundary
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001366 VkDeviceSize imageGranularity = GetPDProperties()->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001367 uint64_t ig_mask = imageGranularity - 1;
1368 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001369
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001370 if (total_size > format_limits.maxResourceSize) {
1371 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1372 kVUID_Core_Image_InvalidFormatLimitsViolation,
1373 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1374 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1375 total_size, format_limits.maxResourceSize);
1376 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001377
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001378 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1379 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1380 "VUID-VkImageCreateInfo-arrayLayers-02256",
1381 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1382 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1383 }
1384
Piers Daniell10a5c762019-03-11 12:44:50 -06001385 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1386 !GetDeviceExtensions()->vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
1387 skip |= log_msg(
1388 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1389 "VUID-VkImageCreateInfo-format-02653",
1390 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1391 pCreateInfo->arrayLayers);
1392 }
1393
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001394 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1395 skip |=
1396 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1397 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001398 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001399 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001400 }
1401
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001402 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001403 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 -06001404 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001405 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1406 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001407 }
1408
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001409 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001410 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1411 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1412 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1413 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001414 skip |=
1415 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1416 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1417 "format must be block, ETC or ASTC compressed, but is %s",
1418 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001419 }
1420 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1421 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001422 skip |=
1423 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1424 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1425 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001426 }
1427 }
1428 }
1429
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001430 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001431 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1432 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1433 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001434 }
1435
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001436 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001437}
1438
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001439void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1440 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001441 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001442 IMAGE_LAYOUT_NODE image_state;
1443 image_state.layout = pCreateInfo->initialLayout;
1444 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001446 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001447 RecordCreateImageANDROID(pCreateInfo, is_node);
1448 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001449 GetImageMap()->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001450 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001451 (*GetImageSubresourceMap())[*pImage].push_back(subpair);
1452 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001453 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001454}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001455
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001456bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001457 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001458 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001459 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001460 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001461 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001462 }
1463 return skip;
1464}
1465
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001466void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001467 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001468 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001469 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001470 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001471 // Clean up memory mapping, bindings and range references for image
1472 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001473 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001474 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001475 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001476 }
1477 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001478 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001479 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001480 // Remove image from imageMap
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001481 GetImageMap()->erase(image);
1482 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap = GetImageSubresourceMap();
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001483
1484 const auto &sub_entry = imageSubresourceMap->find(image);
1485 if (sub_entry != imageSubresourceMap->end()) {
1486 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001487 GetImageLayoutMap()->erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001488 }
1489 imageSubresourceMap->erase(sub_entry);
1490 }
1491}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001492
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001493bool CoreChecks::ValidateImageAttributes(IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001494 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001495
1496 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1497 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1498 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 -06001499 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001500 }
1501
Dave Houlton1d2022c2017-03-29 11:43:58 -06001502 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001503 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1504 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 -06001505 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001506 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001507 char const str[] = "vkCmdClearColorImage called with compressed image.";
1508 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 -06001509 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001510 }
1511
1512 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1513 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1514 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 -06001515 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001516 }
1517 return skip;
1518}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001519
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001520uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1521 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1522 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001523 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001524 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001525 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001526 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001527}
1528
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001529uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1530 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1531 uint32_t array_layer_count = range->layerCount;
1532 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1533 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001534 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001535 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001536}
1537
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001538bool CoreChecks::VerifyClearImageLayout(GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state, VkImageSubresourceRange range,
1539 VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001540 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001541
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001542 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1543 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001544 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1545 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001546 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 -06001547 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001548 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1549 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001550 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001551 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001552 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001553 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 -06001554 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001555 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1556 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001557
1558 } else {
1559 if (image_state->shared_presentable) {
1560 skip |= log_msg(
1561 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001562 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001563 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1564 string_VkImageLayout(dest_image_layout));
1565 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001566 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001567 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001568 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001569 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001570 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001571 } else {
1572 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1573 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001574 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 -06001575 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001576 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1577 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001578 }
1579 }
1580
John Zulauff660ad62019-03-23 07:16:05 -06001581 // Cast to const to prevent creation at validate time.
1582 const auto *subresource_map = GetImageSubresourceLayoutMap(static_cast<const GLOBAL_CB_NODE *>(cb_node), image_state->image);
1583 if (subresource_map) {
1584 bool subres_skip = false;
1585 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
1586 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &subres_skip](
1587 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
1588 LayoutUseCheckAndMessage layout_check(dest_image_layout, layout, initial_layout);
1589 if (layout_check.CheckFailed()) {
1590 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1591 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1592 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1593 } else {
1594 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595 }
John Zulauff660ad62019-03-23 07:16:05 -06001596 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1597 HandleToUint64(cb_node->commandBuffer), error_code,
1598 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1599 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1600 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001601 }
John Zulauff660ad62019-03-23 07:16:05 -06001602 return !subres_skip;
1603 };
1604 subresource_map->ForRange(normalized_isr, subres_callback);
1605 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001606 }
1607
1608 return skip;
1609}
1610
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001611bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1612 const VkClearColorValue *pColor, uint32_t rangeCount,
1613 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001614 bool skip = false;
1615 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001616 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001617 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001618 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001619 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001620 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001621 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001622 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001623 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001624 skip |=
1625 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1626 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001627 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001628 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001629 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001630 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001631 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001632 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1633 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001634 }
1635 }
1636 return skip;
1637}
1638
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001639void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1640 const VkClearColorValue *pColor, uint32_t rangeCount,
1641 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001642 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001643 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001645 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001646 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001647 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001648 }
1649 }
1650}
1651
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001652bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1653 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1654 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001655 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001656
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001657 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001658 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001659 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001660 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001661 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001662 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001663 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001664 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001665 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001666 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001667 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1668 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001669 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001670 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001671 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001672 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001673 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001674 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001675 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001676 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001677 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1678 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001679 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001680 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1681 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001682 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 -06001683 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001684 }
1685 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001686 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001687 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001688 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 -06001689 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001690 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001691 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1692 char const str[] =
1693 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1694 "set.";
1695 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 -06001696 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001697 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001698 }
1699 return skip;
1700}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001701
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001702void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1703 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1704 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001705 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001706 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001707 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001708 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001709 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001710 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001711 }
1712 }
1713}
1714
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001715// Returns true if [x, xoffset] and [y, yoffset] overlap
1716static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1717 bool result = false;
1718 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1719 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1720
1721 if (intersection_max > intersection_min) {
1722 result = true;
1723 }
1724 return result;
1725}
1726
Dave Houltonc991cc92018-03-06 11:08:51 -07001727// Returns true if source area of first copy region intersects dest area of second region
1728// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1729static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001730 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001731
Dave Houltonc991cc92018-03-06 11:08:51 -07001732 // Separate planes within a multiplane image cannot intersect
1733 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001734 return result;
1735 }
1736
Dave Houltonc991cc92018-03-06 11:08:51 -07001737 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1738 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1739 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001740 result = true;
1741 switch (type) {
1742 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001743 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001744 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001745 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001746 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001747 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001748 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001749 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001750 break;
1751 default:
1752 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1753 assert(false);
1754 }
1755 }
1756 return result;
1757}
1758
Dave Houltonfc1a4052017-04-27 14:32:45 -06001759// Returns non-zero if offset and extent exceed image extents
1760static const uint32_t x_bit = 1;
1761static const uint32_t y_bit = 2;
1762static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001763static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001764 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001765 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001766 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1767 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001768 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001769 }
1770 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1771 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001772 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001773 }
1774 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1775 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001776 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001777 }
1778 return result;
1779}
1780
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001781// Test if two VkExtent3D structs are equivalent
1782static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1783 bool result = true;
1784 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1785 (extent->depth != other_extent->depth)) {
1786 result = false;
1787 }
1788 return result;
1789}
1790
Dave Houltonee281a52017-12-08 13:51:02 -07001791// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1792// Destination image texel extents must be adjusted by block size for the dest validation checks
1793VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1794 VkExtent3D adjusted_extent = extent;
1795 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001796 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001797 adjusted_extent.width /= block_size.width;
1798 adjusted_extent.height /= block_size.height;
1799 adjusted_extent.depth /= block_size.depth;
1800 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001801 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001802 adjusted_extent.width *= block_size.width;
1803 adjusted_extent.height *= block_size.height;
1804 adjusted_extent.depth *= block_size.depth;
1805 }
1806 return adjusted_extent;
1807}
1808
Dave Houlton6f9059e2017-05-02 17:15:13 -06001809// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001810static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1811 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001812
1813 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001814 if (mip >= img->createInfo.mipLevels) {
1815 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001816 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001817
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001818 // 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 -06001819 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001820
Dave Houltone48cd112019-01-03 17:01:18 -07001821 // If multi-plane, adjust per-plane extent
1822 if (FormatIsMultiplane(img->createInfo.format)) {
1823 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1824 extent.width /= divisors.width;
1825 extent.height /= divisors.height;
1826 }
1827
Jeff Bolzef40fec2018-09-01 22:04:34 -05001828 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1829 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001830 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001831 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1832 } else {
1833 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1834 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1835 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1836 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001837
Dave Houlton6f9059e2017-05-02 17:15:13 -06001838 // Image arrays have an effective z extent that isn't diminished by mip level
1839 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001840 extent.depth = img->createInfo.arrayLayers;
1841 }
1842
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001843 return extent;
1844}
1845
1846// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001847static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001848 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1849}
1850
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001851// Test if the extent argument has any dimensions set to 0.
1852static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1853 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1854}
1855
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001856// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001857VkExtent3D CoreChecks::GetScaledItg(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001858 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1859 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001860 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001861 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001862 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001863 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001864 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001865 granularity.width *= block_size.width;
1866 granularity.height *= block_size.height;
1867 }
1868 }
1869 return granularity;
1870}
1871
1872// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1873static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1874 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001875 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1876 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001877 valid = false;
1878 }
1879 return valid;
1880}
1881
1882// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001883bool CoreChecks::CheckItgOffset(const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
1884 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001885 bool skip = false;
1886 VkExtent3D offset_extent = {};
1887 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1888 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1889 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001890 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001891 // 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 -07001892 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001893 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 -04001894 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001895 "%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 "
1896 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001897 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001898 }
1899 } else {
1900 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1901 // integer multiples of the image transfer granularity.
1902 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001903 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 -04001904 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001905 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1906 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001907 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1908 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001909 }
1910 }
1911 return skip;
1912}
1913
1914// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001915bool CoreChecks::CheckItgExtent(const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
1916 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
1917 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001918 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001919 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001920 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1921 // subresource extent.
1922 if (IsExtentEqual(extent, subresource_extent) == 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,
Petr Krausbc7f5442017-05-14 23:43:38 +02001925 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1926 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1927 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1928 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001929 }
1930 } else {
1931 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1932 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1933 // subresource extent dimensions.
1934 VkExtent3D offset_extent_sum = {};
1935 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1936 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1937 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001938 bool x_ok = true;
1939 bool y_ok = true;
1940 bool z_ok = true;
1941 switch (image_type) {
1942 case VK_IMAGE_TYPE_3D:
1943 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1944 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001945 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001946 case VK_IMAGE_TYPE_2D:
1947 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1948 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001949 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001950 case VK_IMAGE_TYPE_1D:
1951 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1952 (subresource_extent->width == offset_extent_sum.width));
1953 break;
1954 default:
1955 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1956 assert(false);
1957 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001958 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001959 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 -04001960 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001961 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1962 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1963 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1964 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1965 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1966 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001967 }
1968 }
1969 return skip;
1970}
1971
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001972bool CoreChecks::ValidateImageMipLevel(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level, const uint32_t i,
1973 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001974 bool skip = false;
1975 if (mip_level >= img->createInfo.mipLevels) {
1976 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1977 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07001978 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
1979 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07001980 }
1981 return skip;
1982}
1983
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001984bool CoreChecks::ValidateImageArrayLayerRange(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
1985 const uint32_t layer_count, const uint32_t i, const char *function,
1986 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001987 bool skip = false;
1988 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1989 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1990 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1991 HandleToUint64(cb_node->commandBuffer), vuid,
1992 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07001993 "%u, but provided image %s has %u array layers.",
1994 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
1995 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07001996 }
1997 return skip;
1998}
1999
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002000// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002001bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2002 const VkBufferImageCopy *region, const uint32_t i,
2003 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002004 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002005 VkExtent3D granularity = GetScaledItg(cb_node, img);
2006 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002007 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002008 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002009 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002010 return skip;
2011}
2012
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002013// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002014bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *src_img,
2015 const IMAGE_STATE *dst_img, const VkImageCopy *region,
2016 const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002017 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002018 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002019 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2020 skip |=
2021 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002022 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002023 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002024 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2025 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002026
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002027 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002028 granularity = GetScaledItg(cb_node, dst_img);
2029 skip |=
2030 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002031 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002032 const VkExtent3D dest_effective_extent =
2033 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002034 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002035 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002036 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002037 return skip;
2038}
2039
Dave Houlton6f9059e2017-05-02 17:15:13 -06002040// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002041bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002042 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002043 bool skip = false;
2044
2045 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002046 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002047
2048 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002049 const VkExtent3D src_copy_extent = region.extent;
2050 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002051 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2052
Dave Houlton6f9059e2017-05-02 17:15:13 -06002053 bool slice_override = false;
2054 uint32_t depth_slices = 0;
2055
2056 // Special case for copying between a 1D/2D array and a 3D image
2057 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2058 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002059 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002060 slice_override = (depth_slices != 1);
2061 } 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 -07002062 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002063 slice_override = (depth_slices != 1);
2064 }
2065
2066 // Do all checks on source image
2067 //
2068 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002069 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2070 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 -06002071 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002072 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002073 "be 0 and 1, respectively.",
2074 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002075 }
2076 }
2077
Dave Houlton533be9f2018-03-26 17:08:30 -06002078 // VUID-VkImageCopy-srcImage-01785
2079 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2080 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 -06002081 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002082 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002083 "these must be 0 and 1, respectively.",
2084 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002085 }
2086
Dave Houlton533be9f2018-03-26 17:08:30 -06002087 // VUID-VkImageCopy-srcImage-01787
2088 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2089 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 -06002090 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002091 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2092 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002093 }
2094
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002095 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002096 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002097 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002098 skip |=
2099 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002100 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002101 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002102 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2103 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002104 }
2105 }
2106 } else { // Pre maint 1
2107 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002108 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002109 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-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002111 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2112 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002113 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2114 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 }
2116 }
2117 }
2118
Dave Houltonc991cc92018-03-06 11:08:51 -07002119 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002120 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002121 if (FormatIsCompressed(src_state->createInfo.format) ||
2122 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002123 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002125 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2126 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2127 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002128 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002129 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 -07002130 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002132 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002133 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002134 }
2135
Dave Houlton94a00372017-12-14 15:08:47 -07002136 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002137 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2138 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002139 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002140 skip |=
2141 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002142 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002143 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002144 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002145 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002146 }
2147
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002148 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002149 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2150 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002151 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 skip |=
2153 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002154 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002155 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002156 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002157 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002158 }
2159
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002160 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002161 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2162 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002163 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002164 skip |=
2165 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002166 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002167 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002168 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002169 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002170 }
2171 } // Compressed
2172
2173 // Do all checks on dest image
2174 //
2175 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002176 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002177 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 -06002178 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002179 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002180 "these must be 0 and 1, respectively.",
2181 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002182 }
2183 }
2184
Dave Houlton533be9f2018-03-26 17:08:30 -06002185 // VUID-VkImageCopy-dstImage-01786
2186 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2187 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 -06002188 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002189 "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 -06002190 "and 1, respectively.",
2191 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002192 }
2193
2194 // VUID-VkImageCopy-dstImage-01788
2195 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2196 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 -06002197 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002198 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2199 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002200 }
2201
2202 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002203 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 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 -06002205 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002207 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2208 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002209 }
2210 }
2211 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002212 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002214 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002215 skip |=
2216 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-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002218 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002219 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2220 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002221 }
2222 }
2223 } else { // Pre maint 1
2224 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002225 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002226 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 -06002227 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002228 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2229 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002230 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2231 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002232 }
2233 }
2234 }
2235
Dave Houltonc991cc92018-03-06 11:08:51 -07002236 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2237 if (FormatIsCompressed(dst_state->createInfo.format) ||
2238 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002239 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002240
2241 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002242 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2243 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2244 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002245 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 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 -07002247 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002248 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002249 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002250 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002251 }
2252
Dave Houlton94a00372017-12-14 15:08:47 -07002253 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002254 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2255 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002256 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002257 skip |=
2258 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002259 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002260 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002261 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002262 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002263 }
2264
Dave Houltonee281a52017-12-08 13:51:02 -07002265 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2266 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2267 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002268 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002269 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 -07002270 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002271 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2272 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002273 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002274 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002275 }
2276
Dave Houltonee281a52017-12-08 13:51:02 -07002277 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2278 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2279 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002280 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002281 skip |=
2282 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002283 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002284 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002285 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002286 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002287 }
2288 } // Compressed
2289 }
2290 return skip;
2291}
2292
Dave Houltonc991cc92018-03-06 11:08:51 -07002293// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002294bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2295 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002296 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002297
2298 // Neither image is multiplane
2299 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2300 // If neither image is multi-plane the aspectMask member of src and dst must match
2301 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2302 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002303 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002304 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2305 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 -06002306 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002307 }
2308 } else {
2309 // Source image multiplane checks
2310 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2311 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2312 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2313 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002314 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002315 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 -06002316 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002317 }
2318 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2319 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2320 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002321 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002322 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 -06002323 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002324 }
2325 // Single-plane to multi-plane
2326 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2327 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2328 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002329 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002330 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 -06002331 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002332 }
2333
2334 // Dest image multiplane checks
2335 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2336 aspect = region.dstSubresource.aspectMask;
2337 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2338 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002339 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002340 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 -06002341 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002342 }
2343 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2344 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2345 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002346 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 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 -06002348 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002349 }
2350 // Multi-plane to single-plane
2351 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2352 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2353 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002354 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002355 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 -06002356 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002357 }
2358 }
2359
2360 return skip;
2361}
2362
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002363bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2364 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2365 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002366 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002367 auto src_image_state = GetImageState(srcImage);
2368 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002369 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002370
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002371 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002372
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002373 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2374
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002375 for (uint32_t i = 0; i < regionCount; i++) {
2376 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002377
2378 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2379 VkExtent3D src_copy_extent = region.extent;
2380 VkExtent3D dst_copy_extent =
2381 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2382
Dave Houlton6f9059e2017-05-02 17:15:13 -06002383 bool slice_override = false;
2384 uint32_t depth_slices = 0;
2385
2386 // Special case for copying between a 1D/2D array and a 3D image
2387 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2388 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2389 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002390 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002391 slice_override = (depth_slices != 1);
2392 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2393 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002394 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002395 slice_override = (depth_slices != 1);
2396 }
2397
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002398 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2399 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2400 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002401 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002402 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002403 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002404 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002405 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2406 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002407 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002408 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2409 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002410
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002411 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002412 // No chance of mismatch if we're overriding depth slice count
2413 if (!slice_override) {
2414 // The number of depth slices in srcSubresource and dstSubresource must match
2415 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2416 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002417 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2418 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002419 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002420 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2421 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 if (src_slices != dst_slices) {
2423 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002424 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 << "] do not match";
2426 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002427 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002428 }
2429 }
2430 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002431 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002432 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002433 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002434 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002435 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002436 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 -06002437 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002438 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002439 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002440
Dave Houltonc991cc92018-03-06 11:08:51 -07002441 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002442 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002443 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002444 }
2445
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002446 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002447 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2448 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002449 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002450 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 -06002451 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002452 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002453 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002454
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002455 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002456 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002457 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002458 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002459 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2460 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 -06002461 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002462 }
2463
2464 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002465 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002466 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002467 ss << "vkCmdCopyImage(): pRegion[" << i
2468 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002469 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 -06002470 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002471 }
2472
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002473 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2474 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2475 // 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 -07002476 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2477 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002478 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002479 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002480 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2481 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2482 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002483 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 -06002484 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002485 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002486
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002487 // 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 -07002488 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2489 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002490 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002491 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002492 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2493 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2494 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002495 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002496 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002497 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002498 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002499
Dave Houltonfc1a4052017-04-27 14:32:45 -06002500 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002501 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2502 if (slice_override) src_copy_extent.depth = depth_slices;
2503 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002504 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002505 skip |=
2506 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2507 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2508 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2509 "width [%1d].",
2510 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002511 }
2512
2513 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002514 skip |=
2515 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2516 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2517 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2518 "height [%1d].",
2519 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002520 }
2521 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002522 skip |=
2523 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2524 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2525 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2526 "depth [%1d].",
2527 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002528 }
2529
Dave Houltonee281a52017-12-08 13:51:02 -07002530 // Adjust dest extent if necessary
2531 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2532 if (slice_override) dst_copy_extent.depth = depth_slices;
2533
2534 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002535 if (extent_check & x_bit) {
2536 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002537 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002538 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002539 "width [%1d].",
2540 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002541 }
2542 if (extent_check & y_bit) {
2543 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 -06002544 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002545 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002546 "height [%1d].",
2547 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002548 }
2549 if (extent_check & z_bit) {
2550 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 -06002551 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002552 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002553 "depth [%1d].",
2554 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002555 }
2556
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002557 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2558 // must not overlap in memory
2559 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002560 for (uint32_t j = 0; j < regionCount; j++) {
2561 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002562 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002563 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002564 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002565 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 -06002566 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002567 }
2568 }
2569 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002570 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002571
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002572 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2573 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2574 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002575 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002576 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2577 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002578 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 -06002579 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002580 }
2581 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002582 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002583 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2584 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002585 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002586 }
2587 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002588
Dave Houlton33c22b72017-02-28 13:16:02 -07002589 // Source and dest image sample counts must match
2590 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2591 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2592 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 -06002593 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002594 }
2595
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002596 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2597 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002598 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002599 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2600 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2601 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2602 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07002603 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002604 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2605 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2606 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2607 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002608 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002609 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002610 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002611 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2612 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002613 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002614 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002615 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002616 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2617 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002618 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002619 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002620 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2621 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002622 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002623 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002624 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2625 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002626 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002627 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2628 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002629 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2630 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002631 }
2632
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002633 return skip;
2634}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002635
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002636void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2637 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2638 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002639 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002640 auto src_image_state = GetImageState(srcImage);
2641 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002642
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002643 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002644 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002645 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2646 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002647 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002648 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002649 AddCommandBufferBindingImage(cb_node, src_image_state);
2650 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002651}
2652
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002653// Returns true if sub_rect is entirely contained within rect
2654static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2655 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2656 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2657 return false;
2658 return true;
2659}
2660
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002661bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002662 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2663 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002664 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002665 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2666 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002667 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002668 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002669
2670 for (uint32_t j = 0; j < rect_count; j++) {
2671 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002672 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 -07002673 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2674 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2675 "the current render pass instance.",
2676 j);
2677 }
2678
2679 if (image_view_state) {
2680 // The layers specified by a given element of pRects must be contained within every attachment that
2681 // pAttachments refers to
2682 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2683 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2684 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002685 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2686 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2687 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2688 "of pAttachment[%d].",
2689 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002690 }
2691 }
2692 }
2693 return skip;
2694}
2695
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002696bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2697 const VkClearAttachment *pAttachments, uint32_t rectCount,
2698 const VkClearRect *pRects) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002699 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002700
2701 bool skip = false;
2702 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002703 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002704 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002705 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002706 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002707 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002708 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2709 // 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 -07002710 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2711 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002712 skip |=
2713 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2714 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2715 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2716 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2717 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002718 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002719 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002720 }
2721
2722 // Validate that attachment is in reference list of active subpass
2723 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002724 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002725 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002726 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002727 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002728 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2729 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002730
John Zulauf3a548ef2019-02-01 16:14:07 -07002731 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2732 auto clear_desc = &pAttachments[attachment_index];
2733 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002734
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002735 if (0 == clear_desc->aspectMask) {
2736 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 -06002737 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002738 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2739 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 -06002740 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002741 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002742 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2743 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2744 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2745 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002746 skip |= log_msg(
2747 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2748 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2749 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2750 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2751 attachment_index, clear_desc->colorAttachment,
2752 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2753 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2754
John Zulauff2582972019-02-09 14:53:30 -07002755 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2756 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002757 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002758 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2759 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2760 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2761 " subpass %u. colorAttachmentCount=%u",
2762 attachment_index, clear_desc->colorAttachment,
2763 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2764 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002765 }
John Zulauff2582972019-02-09 14:53:30 -07002766 fb_attachment = color_attachment;
2767
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002768 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2769 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2770 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002771 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002772 skip |=
2773 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2774 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002775 }
2776 } else { // Must be depth and/or stencil
2777 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2778 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002779 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002780 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 -07002781 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2782 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002783 }
2784 if (!subpass_desc->pDepthStencilAttachment ||
2785 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2786 skip |= log_msg(
2787 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002788 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002789 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002790 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002791 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002792 }
2793 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002794 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002795 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2796 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002797 } else {
2798 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2799 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2800 if (!clear_rect_copy) {
2801 // We need a copy of the clear rectangles that will persist until the last lambda executes
2802 // but we want to create it as lazily as possible
2803 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002804 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002805
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002806 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauf3a548ef2019-02-01 16:14:07 -07002807 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2808 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002809 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002810 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2811 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002812 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2813 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002814 return skip;
2815 };
2816 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002817 }
2818 }
2819 }
2820 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002821}
2822
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002823bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2824 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2825 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002826 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002827 auto src_image_state = GetImageState(srcImage);
2828 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002829
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002830 bool skip = false;
2831 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002832 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2833 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002834 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002835 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002836 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2837 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002838 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2839 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002840
Cort Stratton7df30962018-05-17 19:45:57 -07002841 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002842 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002843 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002844 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2845 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2846 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002847 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002848 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2849 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002850 // For each region, the number of layers in the image subresource should not be zero
2851 // For each region, src and dest image aspect must be color only
2852 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002853 skip |=
2854 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2855 skip |=
2856 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002857 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002858 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2859 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002860 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002861 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2862 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002863 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2864 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2865 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2866 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2867 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002868 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2869 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002870 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002871 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2872 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002873
2874 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002875 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2876 skip |= log_msg(
2877 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002878 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002879 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002880 }
Cort Stratton7df30962018-05-17 19:45:57 -07002881 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002882 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2883 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2884 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002885 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002886 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 -06002887 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002888 }
2889 }
2890
2891 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2892 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002893 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 -06002894 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002895 }
2896 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2897 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002898 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 -06002899 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002900 }
2901 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2902 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2903 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 -06002904 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002905 }
2906 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2907 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2908 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 -06002909 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002910 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002911 } else {
2912 assert(0);
2913 }
2914 return skip;
2915}
2916
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002917void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2918 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2919 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002920 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002921 auto src_image_state = GetImageState(srcImage);
2922 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002923
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002924 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002925 AddCommandBufferBindingImage(cb_node, src_image_state);
2926 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002927}
2928
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002929bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2930 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2931 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002932 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002933 auto src_image_state = GetImageState(srcImage);
2934 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002935
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002936 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002937 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002938 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002939 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002940 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002941 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002942 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002943 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002944 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002945 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2946 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002947 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002948 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2949 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002950 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002951 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2952 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002953 skip |=
2954 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002955 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2956 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002957 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002958 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002959 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002960 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002961
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002962 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002963
Dave Houlton33c2d252017-06-09 17:08:32 -06002964 VkFormat src_format = src_image_state->createInfo.format;
2965 VkFormat dst_format = dst_image_state->createInfo.format;
2966 VkImageType src_type = src_image_state->createInfo.imageType;
2967 VkImageType dst_type = dst_image_state->createInfo.imageType;
2968
Cort Stratton186b1a22018-05-01 20:18:06 -04002969 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002970 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002971 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2972 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002973 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002974 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
2975 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
2976 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002977 }
2978
2979 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2980 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002981 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002982 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002983 }
2984
Dave Houlton33c2d252017-06-09 17:08:32 -06002985 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2986 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2987 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 -06002988 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002989 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002990 }
2991
2992 // Validate consistency for unsigned formats
2993 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2994 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002995 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06002996 << "the other one must also have unsigned integer format. "
2997 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
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-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003000 }
3001
3002 // Validate consistency for signed formats
3003 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3004 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003005 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003006 << "the other one must also have signed integer format. "
3007 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3008 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 -06003009 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003010 }
3011
3012 // Validate filter for Depth/Stencil formats
3013 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3014 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003015 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003016 << "then filter must be VK_FILTER_NEAREST.";
3017 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 -06003018 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003019 }
3020
3021 // Validate aspect bits and formats for depth/stencil images
3022 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3023 if (src_format != dst_format) {
3024 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003025 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003026 << "stencil, the other one must have exactly the same format. "
3027 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3028 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003029 skip |=
3030 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3031 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003032 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003033 } // Depth or Stencil
3034
3035 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003036 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003037 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003038 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3039 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3040 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003041 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003042 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3043 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003044 for (uint32_t i = 0; i < regionCount; i++) {
3045 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003046 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003047 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003048 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3049 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003050 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003051 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3052 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003053 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3054 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3055 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003056 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003057 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003058 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003059 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003060 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3061 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003062 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003063 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3064 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003065 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003066 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3067 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003068 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003069 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003070 skip |=
3071 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3072 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003073 }
Dave Houlton48989f32017-05-26 15:01:46 -06003074 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3075 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003076 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003077 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003078 skip |=
3079 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3080 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003081 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003082
3083 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003084 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003085 skip |= log_msg(
3086 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3087 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3088 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003089 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003090
Dave Houlton48989f32017-05-26 15:01:46 -06003091 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003092 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 -06003093 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003094 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003095 }
Dave Houlton48989f32017-05-26 15:01:46 -06003096
Dave Houlton33c2d252017-06-09 17:08:32 -06003097 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3098 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003099 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003100 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003101 "image format %s.",
3102 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003103 }
3104
3105 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3106 skip |= log_msg(
3107 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003108 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003109 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3110 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003111 }
3112
Dave Houlton48989f32017-05-26 15:01:46 -06003113 // Validate source image offsets
3114 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003115 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003116 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003117 skip |=
3118 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3119 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3120 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3121 "of (%1d, %1d). These must be (0, 1).",
3122 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003123 }
3124 }
3125
Dave Houlton33c2d252017-06-09 17:08:32 -06003126 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003127 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3128 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 -06003129 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003130 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003131 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3132 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003133 }
3134 }
3135
Dave Houlton33c2d252017-06-09 17:08:32 -06003136 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003137 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3138 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003139 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003140 skip |= log_msg(
3141 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3142 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3143 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3144 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003145 }
3146 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3147 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003148 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003149 skip |= log_msg(
3150 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003151 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003152 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003153 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003154 }
3155 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3156 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
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-00246",
3161 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3162 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003163 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003164 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003165 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 -06003166 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003167 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003168 }
Dave Houlton48989f32017-05-26 15:01:46 -06003169
3170 // Validate dest image offsets
3171 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003172 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003173 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003174 skip |=
3175 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3176 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3177 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3178 "(%1d, %1d). These must be (0, 1).",
3179 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003180 }
3181 }
3182
Dave Houlton33c2d252017-06-09 17:08:32 -06003183 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003184 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3185 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 -06003186 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003187 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003188 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3189 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003190 }
3191 }
3192
Dave Houlton33c2d252017-06-09 17:08:32 -06003193 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003194 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3195 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003196 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003197 skip |= log_msg(
3198 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3199 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3200 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3201 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003202 }
3203 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3204 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003205 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003206 skip |= log_msg(
3207 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003208 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003209 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003210 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003211 }
3212 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3213 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
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-00251",
3218 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3219 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003220 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003221 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003223 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003224 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003225 }
3226
Dave Houlton33c2d252017-06-09 17:08:32 -06003227 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3228 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3229 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003230 skip |=
3231 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3232 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3233 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3234 "layerCount other than 1.",
3235 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003236 }
3237 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003238 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003239 } else {
3240 assert(0);
3241 }
3242 return skip;
3243}
3244
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003245void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3246 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3247 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003248 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003249 auto src_image_state = GetImageState(srcImage);
3250 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003251
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003252 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003253 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003254 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3255 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003256 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003257 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003258 AddCommandBufferBindingImage(cb_node, src_image_state);
3259 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003260}
3261
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003262// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003263bool CoreChecks::ValidateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003264 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3265 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003266 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06003267 // Iterate over the layout maps for each referenced image
3268 for (const auto &layout_map_entry : pCB->image_layout_map) {
3269 const auto image = layout_map_entry.first;
3270 const auto *image_state = GetImageState(image);
3271 if (!image_state) continue; // Can't check layouts of a dead image
3272 const auto &subres_map = layout_map_entry.second;
3273 ImageSubresourcePair isr_pair;
3274 isr_pair.image = image;
3275 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003276
John Zulauff660ad62019-03-23 07:16:05 -06003277 // Validate the initial_uses for each subresource referenced
3278 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3279 isr_pair.subresource = (*it_init).subresource;
3280 VkImageLayout initial_layout = (*it_init).layout;
3281 VkImageLayout image_layout;
3282 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3283 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3284 // TODO: Set memory invalid which is in mem_tracker currently
3285 } else if (image_layout != initial_layout) {
Lockee9aeebf2019-03-03 23:50:08 -07003286 skip |= log_msg(
3287 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3288 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
John Zulauff660ad62019-03-23 07:16:05 -06003289 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level %u) "
3290 "to be in layout %s--instead, current layout is %s.",
3291 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask, isr_pair.subresource.arrayLayer,
3292 isr_pair.subresource.mipLevel, string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003293 }
3294 }
John Zulauff660ad62019-03-23 07:16:05 -06003295 }
3296
3297 // Update all layout set operations (which will be a subset of the initial_layouts
3298 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3299 VkImageLayout layout = (*it_set).layout;
3300 isr_pair.subresource = (*it_set).subresource;
3301 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003302 }
3303 }
John Zulauff660ad62019-03-23 07:16:05 -06003304
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003305 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003306}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003307
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003308void CoreChecks::UpdateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003309 for (const auto &layout_map_entry : pCB->image_layout_map) {
3310 const auto image = layout_map_entry.first;
3311 const auto *image_state = GetImageState(image);
3312 if (!image_state) continue; // Can't set layouts of a dead image
3313 const auto &subres_map = layout_map_entry.second;
3314 ImageSubresourcePair isr_pair;
3315 isr_pair.image = image;
3316 isr_pair.hasSubresource = true;
3317
3318 // Update all layout set operations (which will be a subset of the initial_layouts
3319 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3320 VkImageLayout layout = (*it_set).layout;
3321 isr_pair.subresource = (*it_set).subresource;
3322 SetGlobalLayout(isr_pair, layout);
3323 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003324 }
3325}
3326
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003327// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003328// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3329// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003330bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3331 const VkImageLayout first_layout, const uint32_t attachment,
3332 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003333 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003334 const char *vuid;
3335 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3336
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003337 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3338 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003339 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3340 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3341 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003342 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003343 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3344 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3345 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3346 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3347 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3348 skip |=
3349 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3350 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003351 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003352 }
3353 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003354 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3355 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003356 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003357 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003358 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 -06003359 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003360 }
3361 }
3362
3363 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3364 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003365 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003366 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003367 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 -06003368 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003369 }
3370 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003371 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003372}
3373
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003374bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003375 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003376 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003377 const char *vuid;
3378 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3379 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003380
Jason Ekstranda1906302017-12-03 20:16:32 -08003381 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3382 VkFormat format = pCreateInfo->pAttachments[i].format;
3383 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3384 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3385 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003386 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 -06003387 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003388 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3389 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3390 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3391 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003392 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003393 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003394 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 -06003395 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003396 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3397 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3398 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3399 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003400 }
3401 }
3402 }
3403
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003404 // Track when we're observing the first use of an attachment
3405 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3406 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003407 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003408
3409 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3410 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3411 auto attach_index = subpass.pInputAttachments[j].attachment;
3412 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003413 switch (subpass.pInputAttachments[j].layout) {
3414 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3415 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3416 // These are ideal.
3417 break;
3418
3419 case VK_IMAGE_LAYOUT_GENERAL:
3420 // May not be optimal. TODO: reconsider this warning based on other constraints.
3421 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003422 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003423 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3424 break;
3425
Tobias Hectorbbb12282018-10-22 15:17:59 +01003426 case VK_IMAGE_LAYOUT_UNDEFINED:
3427 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3428 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3429 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3430 "Layout for input attachment reference %u in subpass %u is %s but must be "
3431 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3432 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3433 break;
3434
Graeme Leese668a9862018-10-08 10:40:02 +01003435 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3436 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003437 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003438 break;
3439 } else {
3440 // Intentionally fall through to generic error message
3441 }
3442 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003443
Cort Stratton7547f772017-05-04 15:18:52 -07003444 default:
3445 // No other layouts are acceptable
3446 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 -06003447 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003448 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3449 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3450 }
3451
Cort Stratton7547f772017-05-04 15:18:52 -07003452 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003453 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3454 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003455
3456 bool used_as_depth =
3457 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3458 bool used_as_color = false;
3459 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3460 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3461 }
3462 if (!used_as_depth && !used_as_color &&
3463 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003464 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3465 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3466 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3467 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003468 }
3469 }
3470 attach_first_use[attach_index] = false;
3471 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003472
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003473 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3474 auto attach_index = subpass.pColorAttachments[j].attachment;
3475 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3476
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003477 // TODO: Need a way to validate shared presentable images here, currently just allowing
3478 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3479 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003480 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003481 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003482 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003483 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3484 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003485 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003486
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003487 case VK_IMAGE_LAYOUT_GENERAL:
3488 // May not be optimal; TODO: reconsider this warning based on other constraints?
3489 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003490 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003491 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3492 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003493
Tobias Hectorbbb12282018-10-22 15:17:59 +01003494 case VK_IMAGE_LAYOUT_UNDEFINED:
3495 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3496 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3497 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3498 "Layout for color attachment reference %u in subpass %u is %s but should be "
3499 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3500 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3501 break;
3502
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003503 default:
3504 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 -06003505 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003506 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3507 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003508 }
3509
John Zulauf4eee2692019-02-09 16:14:25 -07003510 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3511 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3512 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003513 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3514 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 -07003515 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003516 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003517 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003518 }
3519
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003520 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003521 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3522 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003523 }
3524 attach_first_use[attach_index] = false;
3525 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003526
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003527 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3528 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003529 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3530 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3531 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003532 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003533
Dave Houltona9df0ce2018-02-07 10:51:23 -07003534 case VK_IMAGE_LAYOUT_GENERAL:
3535 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3536 // doing a bunch of transitions.
3537 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003538 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003539 "GENERAL layout for depth attachment may not give optimal performance.");
3540 break;
3541
Tobias Hectorbbb12282018-10-22 15:17:59 +01003542 case VK_IMAGE_LAYOUT_UNDEFINED:
3543 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3544 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3545 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3546 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3547 "layout or GENERAL.",
3548 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3549 break;
3550
Dave Houltona9df0ce2018-02-07 10:51:23 -07003551 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3552 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003553 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003554 break;
3555 } else {
3556 // Intentionally fall through to generic error message
3557 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003558 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003559
Dave Houltona9df0ce2018-02-07 10:51:23 -07003560 default:
3561 // No other layouts are acceptable
3562 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 -06003563 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003564 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3565 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3566 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003567 }
3568
3569 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3570 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003571 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3572 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003573 }
3574 attach_first_use[attach_index] = false;
3575 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003576 }
3577 return skip;
3578}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003579
3580// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003581bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEM_INFO const *mem_info, VkDeviceSize offset,
3582 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003583 bool skip = false;
3584 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3585 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003586 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3587 for (auto image_handle : mem_info->bound_images) {
3588 auto img_it = mem_info->bound_ranges.find(image_handle);
3589 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003590 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003591 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003592 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003593 for (auto layout : layouts) {
3594 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003595 skip |=
3596 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 -06003597 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003598 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3599 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003600 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003601 }
3602 }
3603 }
3604 }
3605 }
3606 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003607 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003608}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003609
3610// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3611// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003612bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3613 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003614 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003615 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003616 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003617 if (strict) {
3618 correct_usage = ((actual & desired) == desired);
3619 } else {
3620 correct_usage = ((actual & desired) != 0);
3621 }
3622 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003623 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003624 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003625 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3626 kVUID_Core_MemTrack_InvalidUsageFlag,
3627 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3628 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003629 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003630 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3631 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3632 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003633 }
3634 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003635 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003636}
3637
3638// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3639// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003640bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
3641 char const *func_name, char const *usage_string) {
3642 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003643 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003644}
3645
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003646bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003647 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003648 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003649 bool skip = false;
3650 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3651 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003652 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3653 HandleToUint64(image_state->image), linear_vuid,
3654 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3655 format_properties.linearTilingFeatures, image_state->createInfo.format,
3656 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003657 }
3658 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3659 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3660 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3661 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003662 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003663 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003664 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003665 }
3666 }
3667 return skip;
3668}
3669
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003670bool CoreChecks::ValidateImageSubresourceLayers(const GLOBAL_CB_NODE *cb_node, const VkImageSubresourceLayers *subresource_layers,
3671 char const *func_name, char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003672 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003673 // layerCount must not be zero
3674 if (subresource_layers->layerCount == 0) {
3675 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3676 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3677 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3678 }
3679 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3680 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3681 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3682 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3683 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3684 }
3685 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3686 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3687 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3688 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3689 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3690 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3691 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3692 func_name, i, member);
3693 }
3694 return skip;
3695}
3696
Mark Lobodzinski96210742017-02-09 10:33:46 -07003697// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3698// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003699bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
3700 char const *func_name, char const *usage_string) {
3701 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003702 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003703}
3704
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003705bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3706 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003707 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003708
3709 const VkDeviceSize &range = pCreateInfo->range;
3710 if (range != VK_WHOLE_SIZE) {
3711 // Range must be greater than 0
3712 if (range <= 0) {
3713 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3714 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3715 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3716 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3717 range);
3718 }
3719 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003720 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003721 if (range % format_size != 0) {
3722 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3723 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3724 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3725 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3726 "(" PRINTF_SIZE_T_SPECIFIER ").",
3727 range, format_size);
3728 }
3729 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3730 if (range / format_size > device_limits->maxTexelBufferElements) {
3731 skip |=
3732 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3733 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3734 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3735 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3736 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3737 range, format_size, device_limits->maxTexelBufferElements);
3738 }
3739 // The sum of range and offset must be less than or equal to the size of buffer
3740 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
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-offset-00931",
3743 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3744 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3745 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3746 range, pCreateInfo->offset, buffer_state->createInfo.size);
3747 }
3748 }
3749 return skip;
3750}
3751
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003752bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003753 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003754 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003755 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3756 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3757 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3758 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3759 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3760 "be supported for uniform texel buffers");
3761 }
3762 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3763 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3764 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3765 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3766 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3767 "be supported for storage texel buffers");
3768 }
3769 return skip;
3770}
3771
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003772bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3773 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003774 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003775
Dave Houltond8ed0212018-05-16 17:18:24 -06003776 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003777
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003778 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003779 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 -06003780 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003781 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003782 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003783 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003784
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003785 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003786 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 -06003787 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003788 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003789 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003790 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003791
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003792 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003793 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 -06003794 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003795 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003796 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003797 }
Jeff Bolz87697532019-01-11 22:54:00 -06003798
3799 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3800 if (chained_devaddr_struct) {
3801 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3802 chained_devaddr_struct->deviceAddress != 0) {
3803 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3804 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3805 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3806 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3807 }
3808 }
3809
3810 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003811 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003812 skip |= log_msg(
3813 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3814 "VUID-VkBufferCreateInfo-flags-02605",
3815 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3816 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3817 }
3818
3819 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003820 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003821 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3822 "VUID-VkBufferCreateInfo-usage-02606",
3823 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3824 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3825 }
3826
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003827 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003828 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3829 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3830 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003831 }
3832
Mark Lobodzinski96210742017-02-09 10:33:46 -07003833 return skip;
3834}
3835
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003836void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3837 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003838 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003839 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003840 GetBufferMap()->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003841}
3842
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003843bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3844 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003845 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003846 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003847 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3848 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003849 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003850 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3851 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003852 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003853 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3854 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3855 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003856
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003857 // Buffer view offset must be less than the size of buffer
3858 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3859 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3860 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3861 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3862 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3863 pCreateInfo->offset, buffer_state->createInfo.size);
3864 }
3865
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003866 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003867 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3868 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3869 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3870 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3871 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3872 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3873 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3874 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003875
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003876 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003877
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003878 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003879 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003880 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003881}
3882
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003883void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3884 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003885 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003886 (*GetBufferViewMap())[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003887}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003888
3889// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003890bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
3891 const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003892 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003893 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3894 if (image != VK_NULL_HANDLE) {
3895 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3896 }
3897
Dave Houlton1d2022c2017-03-29 11:43:58 -06003898 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003899 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003900 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003901 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003902 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003903 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003904 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003905 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003906 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003907 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003908 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003909 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003910 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3911 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003912 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003913 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003914 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003915 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3916 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003917 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003918 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003919 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003920 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003921 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003922 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003923 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003924 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003925 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003926 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003927 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_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: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003930 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_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: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003933 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003934 } else if (FormatIsMultiplane(format)) {
3935 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3936 if (3 == FormatPlaneCount(format)) {
3937 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3938 }
3939 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003940 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003941 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3942 "set, where n = [0, 1, 2].",
3943 func_name);
3944 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003945 }
3946 return skip;
3947}
3948
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003949bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
3950 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3951 const char *param_name, const char *image_layer_count_var_name,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003952 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003953 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003954
3955 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003956 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003957 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 -06003958 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003959 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003960 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3961 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003962 }
Petr Kraus4d718682017-05-18 03:38:41 +02003963
Petr Krausffa94af2017-08-08 21:46:02 +02003964 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3965 if (subresourceRange.levelCount == 0) {
3966 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 -06003967 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003968 } else {
3969 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003970
Petr Krausffa94af2017-08-08 21:46:02 +02003971 if (necessary_mip_count > image_mip_count) {
3972 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 -06003973 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003974 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003975 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003976 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003977 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003978 }
Petr Kraus4d718682017-05-18 03:38:41 +02003979 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003980 }
Petr Kraus4d718682017-05-18 03:38:41 +02003981
3982 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003983 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003984 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 -06003985 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003986 "%s: %s.baseArrayLayer (= %" PRIu32
3987 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3988 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003989 }
Petr Kraus4d718682017-05-18 03:38:41 +02003990
Petr Krausffa94af2017-08-08 21:46:02 +02003991 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3992 if (subresourceRange.layerCount == 0) {
3993 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 -06003994 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003995 } else {
3996 const uint64_t necessary_layer_count =
3997 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02003998
Petr Krausffa94af2017-08-08 21:46:02 +02003999 if (necessary_layer_count > image_layer_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.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004002 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004003 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004004 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004005 necessary_layer_count, image_layer_count_var_name, image_layer_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
Mark Lobodzinski602de982017-02-09 11:01:33 -07004010 return skip;
4011}
4012
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004013bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004014 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004015 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004016 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4017 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4018 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4019
4020 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4021 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4022
4023 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004024 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4025 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4026 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4027 : "VUID-VkImageViewCreateInfo-image-01482")
4028 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4029 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4030 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4031 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4032 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004033
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004034 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004035 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4036 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4037}
4038
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004039bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004040 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004041 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004042 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4043 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4044 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4045 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004046
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004047 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4048 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4049 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004050}
4051
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004052bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004053 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004054 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004055 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4056 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4057 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4058 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004059
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004060 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4061 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004062 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4063}
4064
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004065bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004066 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4067 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004068 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004069 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4070 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4071 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4072 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004073
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004074 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4075 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004076 subresourceRangeErrorCodes);
4077}
4078
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004079bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4080 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004081 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004082 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004083 if (image_state) {
4084 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004085 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004086 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004087 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4088 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004089 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004090 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004091 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004092 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004093 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004094 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004095 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004096 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004097
4098 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4099 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004100 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4101 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004102 VkFormat view_format = pCreateInfo->format;
4103 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004104 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004105 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004106
Dave Houltonbd2e2622018-04-10 16:41:14 -06004107 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004108 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004109 if (chained_ivuci_struct) {
4110 if (chained_ivuci_struct->usage & ~image_usage) {
4111 std::stringstream ss;
4112 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004113 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004114 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004115 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 -07004116 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004117 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004118 }
4119
4120 image_usage = chained_ivuci_struct->usage;
4121 }
4122
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004123 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4124 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004125 if (FormatIsMultiplane(image_format)) {
4126 // View format must match the multiplane compatible format
4127 uint32_t plane = 3; // invalid
4128 switch (aspect_mask) {
4129 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4130 plane = 0;
4131 break;
4132 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4133 plane = 1;
4134 break;
4135 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4136 plane = 2;
4137 break;
4138 default:
4139 break;
4140 }
4141
4142 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4143 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004144 std::stringstream ss;
4145 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004146 << " is not compatible with plane " << plane << " of underlying image format "
4147 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004148 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 -07004149 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004150 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004151 }
4152 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004153 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004154 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4155 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4156 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4157 std::stringstream ss;
4158 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004159 << " is not in the same format compatibility class as image ("
4160 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004161 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4162 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004163 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 -07004164 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004165 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004166 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004167 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004168 }
4169 } else {
4170 // Format MUST be IDENTICAL to the format the image was created with
4171 if (image_format != view_format) {
4172 std::stringstream ss;
4173 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004174 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004175 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004176 skip |=
4177 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004178 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004179 }
4180 }
4181
4182 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004183 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004184
4185 switch (image_type) {
4186 case VK_IMAGE_TYPE_1D:
4187 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004188 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 -07004189 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004190 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4191 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004192 }
4193 break;
4194 case VK_IMAGE_TYPE_2D:
4195 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4196 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4197 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004198 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 -07004199 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004200 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4201 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004202 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004203 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 -07004204 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004205 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4206 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004207 }
4208 }
4209 break;
4210 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004211 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004212 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4213 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4214 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004215 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004216 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004217 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004218 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4219 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004220 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4221 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004222 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004223 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004224 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004225 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4226 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004227 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4228 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004229 }
4230 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004231 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 -07004232 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004233 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4234 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004235 }
4236 }
4237 } else {
4238 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004239 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 -07004240 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004241 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4242 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004243 }
4244 }
4245 break;
4246 default:
4247 break;
4248 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004249
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004250 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004251 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004252 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004253 }
4254
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004255 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004256 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4257 : format_properties.optimalTilingFeatures;
4258
4259 if (tiling_features == 0) {
4260 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 -07004261 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004262 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4263 "physical device.",
4264 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4265 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4266 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 -07004267 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004268 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4269 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4270 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4271 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4272 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 -07004273 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004274 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4275 "VK_IMAGE_USAGE_STORAGE_BIT.",
4276 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4277 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4278 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4279 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 -07004280 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004281 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4282 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4283 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4284 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4285 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4286 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 -07004287 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004288 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4289 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4290 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004291 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004292
Jeff Bolz9af91c52018-09-01 21:53:57 -05004293 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4294 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4295 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 -07004296 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004297 "vkCreateImageView() If image was created with usage containing "
4298 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4299 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4300 }
4301 if (view_format != VK_FORMAT_R8_UINT) {
4302 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 -07004303 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004304 "vkCreateImageView() If image was created with usage containing "
4305 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4306 }
4307 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004308 }
4309 return skip;
4310}
4311
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004312void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4313 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004314 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004315 auto image_view_map = GetImageViewMap();
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004316 auto image_state = GetImageState(pCreateInfo->image);
John Zulauff660ad62019-03-23 07:16:05 -06004317 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004318}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004319
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004320bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4321 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004322 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004323 auto src_buffer_state = GetBufferState(srcBuffer);
4324 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004325
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004326 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004327 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4328 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004329 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004330 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004331 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4332 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004333 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004334 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4335 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004336 skip |=
4337 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4338 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004339 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4340 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004341 return skip;
4342}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004343
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004344void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4345 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004346 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004347 auto src_buffer_state = GetBufferState(srcBuffer);
4348 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004349
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004350 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004351 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4352 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004353}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004354
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004355bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004356 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004357 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004358 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004359 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 -07004360 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4361 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004362 } else {
4363 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004364 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 -06004365 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004366 "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 -07004367 }
4368 }
4369 return skip;
4370}
4371
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004372bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004373 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004374 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4375
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004376 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004377 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004378 skip |=
4379 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004380 }
4381 return skip;
4382}
4383
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004384void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004385 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004386 if (!image_view_state) return;
4387 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4388
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004389 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004390 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004391 (*GetImageViewMap()).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004392}
4393
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004394bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004395 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004396
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004397 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004398 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004399 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004400 }
4401 return skip;
4402}
4403
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004404void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004405 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004406 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004407 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4408
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004409 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004410 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004411 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004412 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004413 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004414 }
4415 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004416 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004417 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004418 GetBufferMap()->erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004419}
4420
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004421bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4422 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004423 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004424 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004425 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004426 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004427 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004428 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004429 }
4430 return skip;
4431}
4432
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004433void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004434 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004435 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004436 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4437
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004438 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004439 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004440 GetBufferViewMap()->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004441}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004442
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004443bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4444 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004445 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004446 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004447 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004448 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004449 skip |=
4450 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4451 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004452 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004453 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004454 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4455 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004456 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004457 return skip;
4458}
4459
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004460void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4461 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004462 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004463 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004464 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004465 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004466}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004467
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004468bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4469 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004470 bool skip = false;
4471
4472 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004473 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4474 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004475 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 -06004476 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004477 "%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 -06004478 "and 1, respectively.",
4479 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004480 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004481 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004482
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004483 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4484 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004485 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 -06004486 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004487 "%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 -06004488 "must be 0 and 1, respectively.",
4489 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004490 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004491 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004492
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004493 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4494 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004495 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 -06004496 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004497 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4498 "For 3D images these must be 0 and 1, respectively.",
4499 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004500 }
4501 }
4502
4503 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004504 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004505 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4506
Dave Houltona585d132019-01-18 13:05:42 -07004507 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004508 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 -06004509 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004510 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004511 " must be a multiple of this format's texel size (%" PRIu32 ").",
4512 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004513 }
4514
4515 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004516 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004517 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 -06004518 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004519 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4520 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004521 }
4522
4523 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4524 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004525 skip |=
4526 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004527 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004528 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4529 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004530 }
4531
4532 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4533 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4534 skip |= log_msg(
4535 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004536 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004537 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4538 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004539 }
4540
4541 // subresource aspectMask must have exactly 1 bit set
4542 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4543 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4544 if (aspect_mask_bits.count() != 1) {
4545 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 -06004546 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004547 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004548 }
4549
4550 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004551 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004552 skip |= log_msg(
4553 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004554 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004555 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4556 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004557 }
4558
4559 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004560 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004561 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004562
4563 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004564 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004565 skip |= log_msg(
4566 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004567 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004568 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4569 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004570 }
4571
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004572 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004573 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004574 skip |= log_msg(
4575 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004576 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004577 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4578 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004579 }
4580
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004581 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004582 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4583 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4584 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004585 skip |=
4586 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004587 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004588 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4589 "width & height (%d, %d)..",
4590 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004591 }
4592
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004593 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004594 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004595 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004596 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 -06004597 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004598 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004599 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004600 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004601 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004602
4603 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004604 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004605 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004606 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4607 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 -06004608 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004609 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004610 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004611 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004612 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004613 }
4614
4615 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004616 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004617 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4618 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 -06004619 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004620 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004621 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004622 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004623 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004624 }
4625
4626 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004627 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004628 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4629 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004630 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004631 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004632 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004633 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004634 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004635 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004636 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004637 }
4638
4639 return skip;
4640}
4641
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004642static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004643 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004644 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004645 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004646
4647 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004648 VkExtent3D extent = pRegions[i].imageExtent;
4649 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004650
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004651 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4652 {
Dave Houlton51653902018-06-22 17:32:13 -06004653 skip |=
4654 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4655 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4656 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004657 }
4658
4659 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4660
4661 // 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 -06004662 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004663 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004664 if (image_extent.width % block_extent.width) {
4665 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4666 }
4667 if (image_extent.height % block_extent.height) {
4668 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4669 }
4670 if (image_extent.depth % block_extent.depth) {
4671 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4672 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004673 }
4674
Dave Houltonfc1a4052017-04-27 14:32:45 -06004675 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004676 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 -06004677 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004678 }
4679 }
4680
4681 return skip;
4682}
4683
Chris Forbese8ba09a2017-06-01 17:39:02 -07004684static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004685 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004686 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004687 bool skip = false;
4688
4689 VkDeviceSize buffer_size = buff_state->createInfo.size;
4690
4691 for (uint32_t i = 0; i < regionCount; i++) {
4692 VkExtent3D copy_extent = pRegions[i].imageExtent;
4693
4694 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4695 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004696 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4697 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004698
Tom Cooperb2550c72018-10-15 13:08:41 +01004699 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004700 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004701 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004702 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4703 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4704
4705 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4706 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4707 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004708 }
4709
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004710 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4711 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4712 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004713 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004714 } else {
4715 // Calculate buffer offset of final copied byte, + 1.
4716 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4717 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4718 max_buffer_offset *= unit_size; // convert to bytes
4719 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004720
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004721 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004722 skip |=
4723 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4724 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004725 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004726 }
4727 }
4728
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004729 return skip;
4730}
4731
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004732bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4733 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004734 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004735 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004736 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004737
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004738 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004739
4740 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004741 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004742
4743 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004744 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004745
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004746 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004747
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004748 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4749 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 -06004750 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004751 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004752 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004753 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004754 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004755 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004756 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004757 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004758
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004759 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004760 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004761 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4762 skip |=
4763 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004764
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004765 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004766 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004767 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4768 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004769 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004770 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4771 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004772 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004773 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4774 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004775 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004776 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004777 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004778 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004779 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004780 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004781 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4782 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004783 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004784 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004785 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004786 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004787 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4788 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004789 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4790 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4791 skip |=
4792 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4793 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4794 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004795 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4796 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004797 }
4798 return skip;
4799}
4800
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004801void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4802 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004803 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004804 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004805 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004806
John Zulauff660ad62019-03-23 07:16:05 -06004807 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004808 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004809 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004810 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004811 // Update bindings between buffer/image and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004812 AddCommandBufferBindingImage(cb_node, src_image_state);
4813 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004814}
4815
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004816bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4817 VkImageLayout dstImageLayout, uint32_t regionCount,
4818 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004819 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004820 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004821 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004822
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004823 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004824
4825 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004826 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004827
4828 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004829 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004830 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004831 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4832 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 -06004833 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004834 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004835 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004836 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004837 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004838 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004839 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004840 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004841 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004842 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004843 skip |=
4844 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4845 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004846 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004847 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4848 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004849 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004850 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4851 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004852 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004853 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
4854 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004855 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004856 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004857 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004858 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004859 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004860 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004861 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4862 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004863 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004864 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07004865 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004866 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004867 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4868 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004869 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4870 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
4871 skip |=
4872 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
4873 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4874 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004875 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4876 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004877 }
4878 return skip;
4879}
4880
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004881void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4882 VkImageLayout dstImageLayout, uint32_t regionCount,
4883 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004884 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004885 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004886 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004887
John Zulauff660ad62019-03-23 07:16:05 -06004888 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004889 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004890 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004891 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004892 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4893 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004894}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004895
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004896bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4897 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004898 bool skip = false;
4899 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4900
Dave Houlton1d960ff2018-01-19 12:17:05 -07004901 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004902 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4903 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4904 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004905 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 -06004906 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004907 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004908 }
4909
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004910 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004911 if (!image_entry) {
4912 return skip;
4913 }
4914
Dave Houlton1d960ff2018-01-19 12:17:05 -07004915 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004916 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004917 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4918 "VUID-vkGetImageSubresourceLayout-image-00996",
4919 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004920 }
4921
Dave Houlton1d960ff2018-01-19 12:17:05 -07004922 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004923 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004924 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4925 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4926 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4927 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004928 }
4929
Dave Houlton1d960ff2018-01-19 12:17:05 -07004930 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004931 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004932 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4933 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4934 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4935 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004936 }
4937
Dave Houlton1d960ff2018-01-19 12:17:05 -07004938 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004939 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004940 if (FormatIsMultiplane(img_format)) {
4941 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004942 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004943 if (FormatPlaneCount(img_format) > 2u) {
4944 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004945 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004946 }
4947 if (sub_aspect != (sub_aspect & allowed_flags)) {
4948 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 -06004949 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004950 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004951 ") must be a single-plane specifier flag.",
4952 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004953 }
4954 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004955 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004956 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004957 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004958 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004959 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004960 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004961 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004962 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004963 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 -06004964 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004965 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004966 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004967 }
4968 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004969
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004970 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004971 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004972 }
4973
Mike Weiblen672b58b2017-02-21 14:32:53 -07004974 return skip;
4975}