blob: e52c9cb21955bce27e5b734c6d9fc3dee2ca40b9 [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 Lobodzinskif45e45f2019-04-19 14:15:39 -0600148 if (device_extensions.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 Lobodzinski13deb4f2019-04-19 13:45:20 -0600180 auto imgsubIt = imageLayoutMap.find(imgpair);
181 if (imgsubIt == imageLayoutMap.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 Lobodzinskif45e45f2019-04-19 14:15:39 -0600202 if (device_extensions.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 Lobodzinski13deb4f2019-04-19 13:45:20 -0600209 auto imgsubIt = imageLayoutMap.find(imgpair);
210 if (imgsubIt == imageLayoutMap.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 Lobodzinski2a8d8402019-04-19 13:41:41 -0600217 auto sub_data = imageSubresourceMap.find(image);
218 if (sub_data == imageSubresourceMap.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 Lobodzinski13deb4f2019-04-19 13:45:20 -0600228 auto img_data = imageLayoutMap.find(imgsubpair);
229 if (img_data != imageLayoutMap.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 Lobodzinskif45e45f2019-04-19 14:15:39 -0600258 if (device_extensions.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 Lobodzinski13deb4f2019-04-19 13:45:20 -0600276 auto data = imageLayoutMap.find(imgpair);
277 if (data != imageLayoutMap.end()) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700278 data->second.layout = layout; // Update
279 } else {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -0600280 imageLayoutMap[imgpair].layout = layout; // Insert
Dave Houltonb3f4b282018-02-22 16:25:16 -0700281 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -0600282 auto &image_subresources = imageSubresourceMap[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
284 if (subresource == image_subresources.end()) {
285 image_subresources.push_back(imgpair);
286 }
287}
288
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600289// Set image layout for given VkImageSubresourceRange struct
John Zulauff660ad62019-03-23 07:16:05 -0600290void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
291 const VkImageSubresourceRange &image_subresource_range, VkImageLayout layout,
292 VkImageLayout expected_layout) {
293 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
294 assert(subresource_map); // the non-const getter must return a valid pointer
295 if (subresource_map->SetSubresourceRangeLayout(image_subresource_range, layout, expected_layout)) {
296 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700297 }
298}
John Zulauff660ad62019-03-23 07:16:05 -0600299
300// Set the initial image layout for all slices of an image view
301void CoreChecks::SetImageViewInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
302 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
303 if (image_state) {
304 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, *image_state);
John Zulaufb61ed972019-04-09 16:12:35 -0600305 subresource_map->SetSubresourceRangeInitialLayout(view_state.normalized_subresource_range, layout, *cb_node, &view_state);
John Zulauff660ad62019-03-23 07:16:05 -0600306 }
307}
308
309// Set the initial image layout for a passed non-normalized subresource range
310void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
311 const VkImageSubresourceRange &range, VkImageLayout layout) {
312 auto *subresource_map = GetImageSubresourceLayoutMap(cb_node, image_state);
313 assert(subresource_map);
John Zulaufb61ed972019-04-09 16:12:35 -0600314 subresource_map->SetSubresourceRangeInitialLayout(NormalizeSubresourceRange(image_state, range), layout, *cb_node);
John Zulauff660ad62019-03-23 07:16:05 -0600315}
316
317void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, VkImage image, const VkImageSubresourceRange &range,
318 VkImageLayout layout) {
319 const IMAGE_STATE *image_state = GetImageState(image);
320 if (!image_state) return;
321 SetImageInitialLayout(cb_node, *image_state, range, layout);
322};
323
324void CoreChecks::SetImageInitialLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE &image_state,
325 const VkImageSubresourceLayers &layers, VkImageLayout layout) {
326 SetImageInitialLayout(cb_node, image_state, RangeFromLayers(layers), layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600327}
Dave Houltonddd65c52018-05-08 14:58:01 -0600328
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600329// Set image layout for all slices of an image view
John Zulauff660ad62019-03-23 07:16:05 -0600330void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_VIEW_STATE &view_state, VkImageLayout layout) {
331 IMAGE_STATE *image_state = GetImageState(view_state.create_info.image);
332 if (!image_state) return; // TODO: track/report stale image references
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600333
John Zulauff660ad62019-03-23 07:16:05 -0600334 VkImageSubresourceRange sub_range = view_state.normalized_subresource_range;
Dave Houltonddd65c52018-05-08 14:58:01 -0600335 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
336 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
John Zulauff660ad62019-03-23 07:16:05 -0600337 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 -0600338 sub_range.baseArrayLayer = 0;
339 sub_range.layerCount = image_state->createInfo.extent.depth;
340 }
341
John Zulauff660ad62019-03-23 07:16:05 -0600342 SetImageLayout(cb_node, *image_state, sub_range, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600343}
344
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700345bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
346 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700347 VkFramebuffer framebuffer, VkRenderPass renderpass,
348 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100349 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700350 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100351 const char *vuid;
352 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
353
354 if (!image_state) {
355 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
356 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700357 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
358 "] = image view %s, which refers to an invalid image",
359 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
360 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 return skip;
362 }
363
364 auto image_usage = image_state->createInfo.usage;
365
366 // Check for layouts that mismatch image usages in the framebuffer
367 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
368 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
369 skip |=
370 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 -0700371 "Layout/usage mismatch for attachment %u in render pass %s"
372 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100373 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600374 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
375 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100376 }
377
378 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
379 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
380 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
381 skip |=
382 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 -0700383 "Layout/usage mismatch for attachment %u in render pass %s"
384 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100385 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600386 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
387 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100388 }
389
390 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
391 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
392 skip |=
393 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 -0700394 "Layout/usage mismatch for attachment %u in render pass %s"
395 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100396 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600397 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
398 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100399 }
400
401 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
402 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
403 skip |=
404 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 -0700405 "Layout/usage mismatch for attachment %u in render pass %s"
406 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100407 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600408 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
409 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100410 }
411
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -0600412 if (device_extensions.vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100413 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
414 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
415 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
416 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
417 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
418 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700419 skip |= log_msg(
420 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
421 "Layout/usage mismatch for attachment %u in render pass %s"
422 " - the %s is %s but the image attached to framebuffer %s via image view %s"
423 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600424 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name, string_VkImageLayout(layout),
425 report_data->FormatHandle(framebuffer).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100426 }
427 } else {
428 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
429 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
430 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
431 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
432 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
433 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700434 "Layout/usage mismatch for attachment %u in render pass %s"
435 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Locke7b4f9ac2019-04-01 10:58:17 -0600437 attachment_index, report_data->FormatHandle(renderpass).c_str(), variable_name,
438 string_VkImageLayout(layout), report_data->FormatHandle(framebuffer).c_str(),
Lockee9aeebf2019-03-03 23:50:08 -0700439 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100440 }
441 }
442 return skip;
443}
444
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700445bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
446 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700447 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600448 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700449 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700450 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100451
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700452 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100453 auto framebuffer = framebuffer_state->framebuffer;
454
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700455 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600456 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 -0600457 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700458 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700459 }
John Zulauff660ad62019-03-23 07:16:05 -0600460 const auto *const_pCB = static_cast<const GLOBAL_CB_NODE *>(pCB);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700461 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
462 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700463 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600464
465 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700466 skip |=
467 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
468 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
469 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
470 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
471 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600472 continue;
473 }
474
John Zulauff660ad62019-03-23 07:16:05 -0600475 const VkImage image = view_state->create_info.image;
476 const IMAGE_STATE *image_state = GetImageState(image);
477
478 if (!image_state) {
479 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
480 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
481 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32
482 "] = VkImageView %s references non-extant VkImage %s.",
483 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
484 report_data->FormatHandle(image_view).c_str(), report_data->FormatHandle(image).c_str());
485 continue;
486 }
487 auto attachment_initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100488 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
489
John Zulauff660ad62019-03-23 07:16:05 -0600490 // Cast pCB to const because we don't want to create entries that don't exist here (in case the key changes to something
491 // in common with the non-const version.)
492 const ImageSubresourceLayoutMap *subresource_map =
493 (attachment_initial_layout != VK_IMAGE_LAYOUT_UNDEFINED) ? GetImageSubresourceLayoutMap(const_pCB, image) : nullptr;
494
495 if (subresource_map) { // If no layout information for image yet, will be checked at QueueSubmit time
496 bool subres_skip = false;
497 auto subresource_cb = [this, i, attachment_initial_layout, &subres_skip](
498 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
499 LayoutUseCheckAndMessage layout_check(attachment_initial_layout, layout, initial_layout);
500 if (layout_check.CheckFailed()) {
501 subres_skip |=
502 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
503 kVUID_Core_DrawState_InvalidRenderpass,
504 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
505 "and the %s layout of the attachment is %s. The layouts must match, or the render "
506 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
507 i, string_VkImageLayout(attachment_initial_layout), layout_check.message,
508 string_VkImageLayout(layout_check.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700509 }
John Zulauff660ad62019-03-23 07:16:05 -0600510 return !subres_skip; // quit checking subresources once we fail once
511 };
512
513 subresource_map->ForRange(view_state->normalized_subresource_range, subresource_cb);
514 skip |= subres_skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700515 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100516
John Zulauff660ad62019-03-23 07:16:05 -0600517 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_initial_layout, image, image_view, framebuffer,
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700518 render_pass, i, "initial layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100519
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700520 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer, render_pass,
521 i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 }
523
524 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
525 auto &subpass = pRenderPassInfo->pSubpasses[j];
526 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
527 auto &attachment_ref = subpass.pInputAttachments[k];
528 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
529 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700530 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100531
532 if (view_state) {
533 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700534 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
535 framebuffer, render_pass, attachment_ref.attachment,
536 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100537 }
538 }
539 }
540
541 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
542 auto &attachment_ref = subpass.pColorAttachments[k];
543 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
544 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700545 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100546
547 if (view_state) {
548 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700549 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
550 framebuffer, render_pass, attachment_ref.attachment,
551 "color attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100552 if (subpass.pResolveAttachments) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700553 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
554 framebuffer, render_pass, attachment_ref.attachment,
555 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100556 }
557 }
558 }
559 }
560
561 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
562 auto &attachment_ref = *subpass.pDepthStencilAttachment;
563 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
564 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700565 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100566
567 if (view_state) {
568 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700569 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
570 framebuffer, render_pass, attachment_ref.attachment,
571 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100572 }
573 }
574 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600576 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700577}
578
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700579void CoreChecks::TransitionAttachmentRefLayout(GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700580 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700581 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700582 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600583 if (image_view) {
John Zulauff660ad62019-03-23 07:16:05 -0600584 SetImageViewLayout(pCB, *image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600585 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700586 }
587}
588
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700589void CoreChecks::TransitionSubpassLayouts(GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state, const int subpass_index,
590 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700591 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700592
593 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700594 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700595 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700596 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700597 }
598 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700599 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 }
601 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700602 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700603 }
604 }
605}
606
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700607// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
608// 1. Transition into initialLayout state
609// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700610void CoreChecks::TransitionBeginRenderPassLayouts(GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700611 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700612 // First transition into initialLayout
613 auto const rpci = render_pass_state->createInfo.ptr();
614 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700615 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600616 if (view_state) {
John Zulauff660ad62019-03-23 07:16:05 -0600617 SetImageViewLayout(cb_state, *view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600618 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700619 }
620 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700621 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700622}
623
Dave Houlton10b39482017-03-16 13:18:15 -0600624bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600625 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600626 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600627 }
628 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600629 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600630 }
631 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600632 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600633 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700634 if (0 !=
635 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
636 if (FormatPlaneCount(format) == 1) return false;
637 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600638 return true;
639}
640
Mike Weiblen62d08a32017-03-07 22:18:27 -0700641// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700642bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier *img_barrier, bool new_not_old,
643 VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700644 bool skip = false;
645 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600646 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700647
648 switch (layout) {
649 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
650 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600651 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700652 }
653 break;
654 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
655 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600656 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700657 }
658 break;
659 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
660 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600661 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700662 }
663 break;
664 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
665 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600666 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700667 }
668 break;
669 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
670 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600671 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700672 }
673 break;
674 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
675 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600676 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700677 }
678 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600679 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500680 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
681 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
682 }
683 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 default:
685 // Other VkImageLayout values do not have VUs defined in this context.
686 break;
687 }
688
Dave Houlton8e9f6542018-05-18 12:18:22 -0600689 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600690 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 -0600691 HandleToUint64(img_barrier->image), msg_code,
John Zulauff660ad62019-03-23 07:16:05 -0600692 "%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 -0700693 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
694 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700695 }
696 return skip;
697}
698
John Zulauf463c51e2018-05-31 13:29:20 -0600699// Scoreboard for checking for duplicate and inconsistent barriers to images
700struct ImageBarrierScoreboardEntry {
701 uint32_t index;
702 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
703 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
704 const VkImageMemoryBarrier *barrier;
705};
706using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
707using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
708
Mike Weiblen62d08a32017-03-07 22:18:27 -0700709// Verify image barriers are compatible with the images they reference.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700710bool CoreChecks::ValidateBarriersToImages(GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700711 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700712 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700713
John Zulauf463c51e2018-05-31 13:29:20 -0600714 // Scoreboard for duplicate layout transition barriers within the list
715 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
716 ImageBarrierScoreboardImageMap layout_transitions;
717
Mike Weiblen62d08a32017-03-07 22:18:27 -0700718 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
719 auto img_barrier = &pImageMemoryBarriers[i];
720 if (!img_barrier) continue;
721
John Zulauf463c51e2018-05-31 13:29:20 -0600722 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
723 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
724 // at a per sub-resource level
725 if (img_barrier->oldLayout != img_barrier->newLayout) {
726 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
727 auto image_it = layout_transitions.find(img_barrier->image);
728 if (image_it != layout_transitions.end()) {
729 auto &subres_map = image_it->second;
730 auto subres_it = subres_map.find(img_barrier->subresourceRange);
731 if (subres_it != subres_map.end()) {
732 auto &entry = subres_it->second;
733 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
734 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
735 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
736 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700737 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
738 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700739 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600740 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
741 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700742 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700743 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
744 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600745 }
746 entry = new_entry;
747 } else {
748 subres_map[img_barrier->subresourceRange] = new_entry;
749 }
750 } else {
751 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
752 }
753 }
754
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700755 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600756 if (image_state) {
757 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700758 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name);
759 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600760
761 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
762 if (image_state->layout_locked) {
763 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600764 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700765 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
766 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700767 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600768 " 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 -0700769 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
770 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600771 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600772
John Zulauff660ad62019-03-23 07:16:05 -0600773 VkImageCreateInfo *image_create_info = &image_state->createInfo;
774 // For a Depth/Stencil image both aspects MUST be set
775 if (FormatIsDepthAndStencil(image_create_info->format)) {
776 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
777 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
778 if ((aspect_mask & ds_mask) != (ds_mask)) {
779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
780 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
781 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
782 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
783 func_name, static_cast<const void *>(img_barrier),
784 report_data->FormatHandle(img_barrier->image).c_str(),
785 string_VkFormat(image_create_info->format), aspect_mask);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700786 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700787 }
John Zulauff660ad62019-03-23 07:16:05 -0600788
789 const auto *subresource_map = GetImageSubresourceLayoutMap(cb_state, img_barrier->image);
790 if (img_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
791 // TODO: Set memory invalid which is in mem_tracker currently
792 // Not sure if this needs to be in the ForRange traversal, pulling it out as it is currently invariant with
793 // subresource.
794 } else if (subresource_map) {
795 bool subres_skip = false;
796 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, img_barrier->subresourceRange);
797 auto subres_callback = [this, img_barrier, cb_state, &subres_skip](
798 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
799 LayoutUseCheckAndMessage layout_check(img_barrier->oldLayout, layout, initial_layout);
800 if (layout_check.CheckFailed()) {
801 subres_skip =
802 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
803 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
804 "For image %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when the "
805 "%s layout is %s.",
806 report_data->FormatHandle(img_barrier->image).c_str(), subres.aspectMask, subres.mipLevel,
807 subres.arrayLayer, string_VkImageLayout(img_barrier->oldLayout), layout_check.message,
808 string_VkImageLayout(layout_check.layout));
809 }
810 return !subres_skip;
811 };
812 subresource_map->ForRange(normalized_isr, subres_callback);
813 skip |= subres_skip;
814 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700815 }
816 }
817 return skip;
818}
819
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700820bool CoreChecks::IsReleaseOp(GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600821 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700822
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700823 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700824 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700825}
826
John Zulauf6b4aae82018-05-09 13:03:36 -0600827template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700828bool CoreChecks::ValidateQFOTransferBarrierUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
829 const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600830 using BarrierRecord = QFOTransferBarrier<Barrier>;
831 bool skip = false;
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700832 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600833 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
834 const char *barrier_name = BarrierRecord::BarrierName();
835 const char *handle_name = BarrierRecord::HandleName();
836 const char *transfer_type = nullptr;
837 for (uint32_t b = 0; b < barrier_count; b++) {
838 if (!IsTransferOp(&barriers[b])) continue;
839 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700840 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
841 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600842 const auto found = barrier_sets.release.find(barriers[b]);
843 if (found != barrier_sets.release.cend()) {
844 barrier_record = &(*found);
845 transfer_type = "releasing";
846 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600847 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
848 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600849 const auto found = barrier_sets.acquire.find(barriers[b]);
850 if (found != barrier_sets.acquire.cend()) {
851 barrier_record = &(*found);
852 transfer_type = "acquiring";
853 }
854 }
855 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700856 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
857 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
858 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
859 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
860 func_name, barrier_name, b, transfer_type, handle_name,
861 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
862 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600863 }
864 }
865 return skip;
866}
867
868template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700869void CoreChecks::RecordQFOTransferBarriers(GLOBAL_CB_NODE *cb_state, uint32_t barrier_count, const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700870 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600871 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
872 for (uint32_t b = 0; b < barrier_count; b++) {
873 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700874 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
875 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600876 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600877 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
878 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600879 barrier_sets.acquire.emplace(barriers[b]);
880 }
881 }
882}
883
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700884bool CoreChecks::ValidateBarriersQFOTransferUniqueness(const char *func_name, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
885 const VkBufferMemoryBarrier *pBufferMemBarriers,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700886 uint32_t imageMemBarrierCount,
887 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600888 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700889 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
890 skip |= ValidateQFOTransferBarrierUniqueness(func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600891 return skip;
892}
893
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700894void CoreChecks::RecordBarriersQFOTransfers(GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700895 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
896 const VkImageMemoryBarrier *pImageMemBarriers) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700897 RecordQFOTransferBarriers(cb_state, bufferBarrierCount, pBufferMemBarriers);
898 RecordQFOTransferBarriers(cb_state, imageMemBarrierCount, pImageMemBarriers);
John Zulauf6b4aae82018-05-09 13:03:36 -0600899}
900
901template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700902bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
903 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600904 // Record to the scoreboard or report that we have a duplication
905 bool skip = false;
906 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
907 if (!inserted.second && inserted.first->second != cb_state) {
908 // 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 -0700909 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
910 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
911 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
912 " duplicates existing barrier submitted in this batch from command buffer %s.",
913 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
914 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
John Zulauf7eb94822019-04-05 09:38:46 -0600915 report_data->FormatHandle(inserted.first->second->commandBuffer).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600916 }
917 return skip;
918}
919
920template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700921bool CoreChecks::ValidateQueuedQFOTransferBarriers(GLOBAL_CB_NODE *cb_state, QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600922 using BarrierRecord = QFOTransferBarrier<Barrier>;
923 using TypeTag = typename BarrierRecord::Tag;
924 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600925 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700926 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600927 const char *barrier_name = BarrierRecord::BarrierName();
928 const char *handle_name = BarrierRecord::HandleName();
929 // No release should have an extant duplicate (WARNING)
930 for (const auto &release : cb_barriers.release) {
931 // Check the global pending release barriers
932 const auto set_it = global_release_barriers.find(release.handle);
933 if (set_it != global_release_barriers.cend()) {
934 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
935 const auto found = set_for_handle.find(release);
936 if (found != set_for_handle.cend()) {
937 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
938 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700939 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600940 " to dstQueueFamilyIndex %" PRIu32
941 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700942 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600943 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
944 }
945 }
946 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
947 }
948 // Each acquire must have a matching release (ERROR)
949 for (const auto &acquire : cb_barriers.acquire) {
950 const auto set_it = global_release_barriers.find(acquire.handle);
951 bool matching_release_found = false;
952 if (set_it != global_release_barriers.cend()) {
953 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
954 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
955 }
956 if (!matching_release_found) {
957 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
958 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700959 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
960 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
961 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
963 }
964 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
965 }
966 return skip;
967}
968
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700969bool CoreChecks::ValidateQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700970 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
971 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600972 bool skip = false;
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700973 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state, qfo_image_scoreboards);
974 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state, qfo_buffer_scoreboards);
John Zulauf6b4aae82018-05-09 13:03:36 -0600975 return skip;
976}
977
978template <typename Barrier>
Mark Lobodzinskidaea5912019-03-07 14:47:09 -0700979void CoreChecks::RecordQueuedQFOTransferBarriers(GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600980 using BarrierRecord = QFOTransferBarrier<Barrier>;
981 using TypeTag = typename BarrierRecord::Tag;
982 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700983 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600984
985 // Add release barriers from this submit to the global map
986 for (const auto &release : cb_barriers.release) {
987 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
988 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
989 global_release_barriers[release.handle].insert(release);
990 }
991
992 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
993 for (const auto &acquire : cb_barriers.acquire) {
994 // NOTE: We're not using [] because we don't want to create entries for missing releases
995 auto set_it = global_release_barriers.find(acquire.handle);
996 if (set_it != global_release_barriers.end()) {
997 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
998 set_for_handle.erase(acquire);
999 if (set_for_handle.size() == 0) { // Clean up empty sets
1000 global_release_barriers.erase(set_it);
1001 }
1002 }
1003 }
1004}
1005
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001006void CoreChecks::RecordQueuedQFOTransfers(GLOBAL_CB_NODE *cb_state) {
1007 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(cb_state);
1008 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(cb_state);
John Zulauf6b4aae82018-05-09 13:03:36 -06001009}
1010
John Zulauf6b4aae82018-05-09 13:03:36 -06001011// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001012void CoreChecks::EraseQFOImageRelaseBarriers(const VkImage &image) { EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image); }
John Zulauf6b4aae82018-05-09 13:03:36 -06001013
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001014void CoreChecks::TransitionImageLayouts(GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001015 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001016 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1017 auto mem_barrier = &pImgMemBarriers[i];
1018 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001019
Chris Forbes4de4b132017-08-21 11:27:08 -07001020 // For ownership transfers, the barrier is specified twice; as a release
1021 // operation on the yielding queue family, and as an acquire operation
1022 // on the acquiring queue family. This barrier may also include a layout
1023 // transition, which occurs 'between' the two operations. For validation
1024 // purposes it doesn't seem important which side performs the layout
1025 // transition, but it must not be performed twice. We'll arbitrarily
1026 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001027 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001028 continue;
1029 }
1030
John Zulauff660ad62019-03-23 07:16:05 -06001031 auto *image_state = GetImageState(mem_barrier->image);
1032 if (!image_state) continue;
1033
1034 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, mem_barrier->subresourceRange);
1035 const auto &image_create_info = image_state->createInfo;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001036
Dave Houltonb3f4b282018-02-22 16:25:16 -07001037 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1038 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1039 // for all (potential) layer sub_resources.
John Zulauff660ad62019-03-23 07:16:05 -06001040 if (0 != (image_create_info.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
1041 normalized_isr.baseArrayLayer = 0;
1042 normalized_isr.layerCount = image_create_info.extent.depth; // Treat each depth slice as a layer subresource
Dave Houltonb3f4b282018-02-22 16:25:16 -07001043 }
1044
John Zulauff660ad62019-03-23 07:16:05 -06001045 SetImageLayout(cb_state, *image_state, normalized_isr, mem_barrier->newLayout, mem_barrier->oldLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001046 }
1047}
1048
John Zulauff660ad62019-03-23 07:16:05 -06001049bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state, const VkImageSubresourceRange &range,
John Zulaufabcc8292019-04-08 18:07:44 -06001050 VkImageAspectFlags aspect_mask, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
1051 const char *caller, const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code,
1052 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;
John Zulaufabcc8292019-04-08 18:07:44 -06001061 auto subresource_cb = [this, explicit_layout, cb_node, layout_mismatch_msg_code, caller, image, aspect_mask, &error,
1062 &subres_skip](const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
1063 LayoutUseCheckAndMessage layout_check(explicit_layout, layout, initial_layout, aspect_mask);
John Zulauff660ad62019-03-23 07:16:05 -06001064 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 Lobodzinskif45e45f2019-04-19 14:15:39 -06001091 } else if (device_extensions.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 Lobodzinski1ee06e92019-04-19 14:03:53 -06001178 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_ext_formats_set.count(ext_fmt_android->externalFormat))) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001179 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1180 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001181 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001182 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1183 }
1184 }
1185
Dave Houltond9611312018-11-19 17:03:36 -07001186 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001187 if (VK_FORMAT_UNDEFINED == create_info->format) {
1188 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1189 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001190 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001191 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1192 }
1193 }
1194
1195 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1196 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1197 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001198 skip |=
1199 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1200 "VUID-VkImageCreateInfo-pNext-02393",
1201 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1202 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1203 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001204 }
1205
1206 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1207 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1208 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001209 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001210 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1211 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1212 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1213 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001214 }
1215
1216 return skip;
1217}
1218
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001219void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001220 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1221 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1222 is_node->imported_ahb = true;
1223 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001224 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001225 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001226 is_node->has_ahb_format = true;
1227 is_node->ahb_format = ext_fmt_android->externalFormat;
1228 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001229}
1230
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001231bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001232 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001233 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001234
1235 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001236 if (VK_FORMAT_UNDEFINED != create_info->format) {
1237 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1238 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1239 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1240 "format member is %s.",
1241 string_VkFormat(create_info->format));
1242 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001243
Dave Houltond9611312018-11-19 17:03:36 -07001244 // Chain must include a compatible ycbcr conversion
1245 bool conv_found = false;
1246 uint64_t external_format = 0;
1247 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1248 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001249 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001250 if (ycbcr_conversion_ahb_fmt_map.find(conv_handle) != ycbcr_conversion_ahb_fmt_map.end()) {
Dave Houltond9611312018-11-19 17:03:36 -07001251 conv_found = true;
Mark Lobodzinskib32db312019-04-19 14:01:08 -06001252 external_format = ycbcr_conversion_ahb_fmt_map.at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001253 }
Dave Houltond9611312018-11-19 17:03:36 -07001254 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001255 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001256 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 -07001257 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1258 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1259 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1260 }
1261
1262 // Errors in create_info swizzles
1263 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1264 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1265 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1266 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1267 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1268 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1269 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1270 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001271 }
1272 }
Dave Houltond9611312018-11-19 17:03:36 -07001273
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001274 return skip;
1275}
1276
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001277bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001278 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001279
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001280 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001281 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1282 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1283 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001284 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001285 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1286 "bound to memory.");
1287 }
1288 return skip;
1289}
1290
1291#else
1292
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001293bool CoreChecks::ValidateCreateImageANDROID(const debug_report_data *report_data, const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001294 return false;
1295}
1296
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001297void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001298
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001299bool CoreChecks::ValidateCreateImageViewANDROID(const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001300
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001301bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001302
1303#endif // VK_USE_PLATFORM_ANDROID_KHR
1304
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001305bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1306 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001307 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001308
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001309 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07001310 skip |= ValidateCreateImageANDROID(report_data, pCreateInfo);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001311 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1312 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1313 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1314 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001315 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001317 }
1318
Dave Houlton130c0212018-01-29 13:39:56 -07001319 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001320 skip |= log_msg(
1321 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1322 "VUID-VkImageCreateInfo-flags-00949",
1323 "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 -07001324 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001325
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001326 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Dave Houlton130c0212018-01-29 13:39:56 -07001327 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1328 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1329 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001330 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 +00001331 "VUID-VkImageCreateInfo-usage-00964",
1332 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1333 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001334 }
1335
1336 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001337 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 +00001338 "VUID-VkImageCreateInfo-usage-00965",
1339 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1340 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001341 }
1342
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001343 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001344 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001345 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1346 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1347 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1348 string_VkFormat(pCreateInfo->format));
1349 } else {
1350 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1351 const char *format_string = string_VkFormat(pCreateInfo->format);
1352 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1353 "VUID-VkImageCreateInfo-mipLevels-02255",
1354 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1355 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1356 }
Dave Houlton130c0212018-01-29 13:39:56 -07001357
Dave Houltona585d132019-01-18 13:05:42 -07001358 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1359 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1360 (uint64_t)pCreateInfo->samples;
1361 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001362
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001363 // Round up to imageGranularity boundary
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06001364 VkDeviceSize imageGranularity = phys_dev_props.limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001365 uint64_t ig_mask = imageGranularity - 1;
1366 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001367
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001368 if (total_size > format_limits.maxResourceSize) {
1369 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1370 kVUID_Core_Image_InvalidFormatLimitsViolation,
1371 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1372 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1373 total_size, format_limits.maxResourceSize);
1374 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001375
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001376 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1377 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1378 "VUID-VkImageCreateInfo-arrayLayers-02256",
1379 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1380 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1381 }
1382
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001383 if (device_extensions.vk_khr_sampler_ycbcr_conversion && FormatRequiresYcbcrConversion(pCreateInfo->format) &&
1384 !device_extensions.vk_ext_ycbcr_image_arrays && pCreateInfo->arrayLayers > 1) {
Piers Daniell10a5c762019-03-11 12:44:50 -06001385 skip |= log_msg(
1386 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1387 "VUID-VkImageCreateInfo-format-02653",
1388 "vkCreateImage(): arrayLayers=%d exceeds the maximum allowed of 1 for formats requiring sampler ycbcr conversion",
1389 pCreateInfo->arrayLayers);
1390 }
1391
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001392 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1393 skip |=
1394 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1395 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001396 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001397 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001398 }
1399
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06001400 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001401 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 -06001402 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001403 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1404 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001405 }
1406
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001407 if (device_extensions.vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001408 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1409 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1410 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1411 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001412 skip |=
1413 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1414 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1415 "format must be block, ETC or ASTC compressed, but is %s",
1416 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001417 }
1418 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1419 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001420 skip |=
1421 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1422 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1423 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001424 }
1425 }
1426 }
1427
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001428 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001429 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateImage",
1430 "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1431 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001432 }
1433
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001434 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001435}
1436
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001437void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1438 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001439 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001440 IMAGE_LAYOUT_NODE image_state;
1441 image_state.layout = pCreateInfo->initialLayout;
1442 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001443 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001444 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001445 RecordCreateImageANDROID(pCreateInfo, is_node);
1446 }
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001447 imageMap.insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001448 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001449 imageSubresourceMap[*pImage].push_back(subpair);
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001450 imageLayoutMap[subpair] = image_state;
1451 imageLayoutMap[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001452}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001453
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001454bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001455 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001456 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001457 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001458 if (image_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001459 skip |= ValidateObjectNotInUse(image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001460 }
1461 return skip;
1462}
1463
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001464void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001465 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001466 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001467 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001468 InvalidateCommandBuffers(image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001469 // Clean up memory mapping, bindings and range references for image
1470 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001471 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001472 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001473 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001474 }
1475 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001476 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001477 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001478 // Remove image from imageMap
Mark Lobodzinski34e04bf2019-04-19 13:31:53 -06001479 imageMap.erase(image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001480
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001481 const auto &sub_entry = imageSubresourceMap.find(image);
1482 if (sub_entry != imageSubresourceMap.end()) {
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001483 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski13deb4f2019-04-19 13:45:20 -06001484 imageLayoutMap.erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001485 }
Mark Lobodzinski2a8d8402019-04-19 13:41:41 -06001486 imageSubresourceMap.erase(sub_entry);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001487 }
1488}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001489
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001490bool CoreChecks::ValidateImageAttributes(IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001491 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001492
1493 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1494 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1495 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 -06001496 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001497 }
1498
Dave Houlton1d2022c2017-03-29 11:43:58 -06001499 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001500 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1501 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 -06001502 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001503 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001504 char const str[] = "vkCmdClearColorImage called with compressed image.";
1505 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 -06001506 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001507 }
1508
1509 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1510 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1511 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 -06001512 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001513 }
1514 return skip;
1515}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001516
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001517uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1518 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1519 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001520 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001521 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001522 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001523 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001524}
1525
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001526uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1527 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1528 uint32_t array_layer_count = range->layerCount;
1529 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1530 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001531 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001532 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001533}
1534
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001535bool CoreChecks::VerifyClearImageLayout(GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state, VkImageSubresourceRange range,
1536 VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001537 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001538
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001539 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1540 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001541 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1542 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001543 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 -06001544 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001545 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1546 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001547 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001548 if (!device_extensions.vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001549 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001550 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 -06001551 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001552 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1553 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001554
1555 } else {
1556 if (image_state->shared_presentable) {
1557 skip |= log_msg(
1558 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001559 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001560 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1561 string_VkImageLayout(dest_image_layout));
1562 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001563 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001564 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001565 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001566 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001567 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001568 } else {
1569 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1570 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001571 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 -06001572 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001573 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1574 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001575 }
1576 }
1577
John Zulauff660ad62019-03-23 07:16:05 -06001578 // Cast to const to prevent creation at validate time.
1579 const auto *subresource_map = GetImageSubresourceLayoutMap(static_cast<const GLOBAL_CB_NODE *>(cb_node), image_state->image);
1580 if (subresource_map) {
1581 bool subres_skip = false;
1582 VkImageSubresourceRange normalized_isr = NormalizeSubresourceRange(*image_state, range);
1583 auto subres_callback = [this, cb_node, dest_image_layout, func_name, &subres_skip](
1584 const VkImageSubresource &subres, VkImageLayout layout, VkImageLayout initial_layout) {
1585 LayoutUseCheckAndMessage layout_check(dest_image_layout, layout, initial_layout);
1586 if (layout_check.CheckFailed()) {
1587 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
1588 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
1589 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
1590 } else {
1591 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001592 }
John Zulauff660ad62019-03-23 07:16:05 -06001593 subres_skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1594 HandleToUint64(cb_node->commandBuffer), error_code,
1595 "%s: Cannot clear an image whose layout is %s and doesn't match the %s layout %s.",
1596 func_name, string_VkImageLayout(dest_image_layout), layout_check.message,
1597 string_VkImageLayout(layout_check.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001598 }
John Zulauff660ad62019-03-23 07:16:05 -06001599 return !subres_skip;
1600 };
1601 subresource_map->ForRange(normalized_isr, subres_callback);
1602 skip |= subres_skip;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001603 }
1604
1605 return skip;
1606}
1607
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001608bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1609 const VkClearColorValue *pColor, uint32_t rangeCount,
1610 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001611 bool skip = false;
1612 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001613 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001614 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001615 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001616 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-image-00003");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001617 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001618 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001619 skip |= ValidateCmd(cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001620 if (GetApiVersion() >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001621 skip |=
1622 ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearColorImage",
1623 "VUID-vkCmdClearColorImage-image-01993", "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001624 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001625 skip |= InsideRenderPass(cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001626 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001627 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001628 skip |= ValidateCmdClearColorSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001629 skip |= ValidateImageAttributes(image_state, pRanges[i]);
1630 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001631 }
1632 }
1633 return skip;
1634}
1635
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001636void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1637 const VkClearColorValue *pColor, uint32_t rangeCount,
1638 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001639 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001640 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001641 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001642 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001644 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001645 }
1646 }
1647}
1648
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001649bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1650 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1651 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001652 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001653
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001654 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001655 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001656 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001657 if (cb_node && image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07001658 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCmdClearDepthStencilImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06001659 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07001660 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001661 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001662 skip |= ValidateCmd(cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06001663 if (GetApiVersion() >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001664 skip |= ValidateImageFormatFeatureFlags(image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdClearDepthStencilImage",
1665 "VUID-vkCmdClearDepthStencilImage-image-01994",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001666 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001667 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001668 skip |= InsideRenderPass(cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001669 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001670 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07001671 skip |= ValidateCmdClearDepthSubresourceRange(image_state, pRanges[i], param_name.c_str());
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001672 skip |= VerifyClearImageLayout(cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001673 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001674 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1675 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001676 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001677 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1678 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001679 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 -06001680 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001681 }
1682 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001683 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001684 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001685 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001686 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001687 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001688 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1689 char const str[] =
1690 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1691 "set.";
1692 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 -06001693 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001694 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001695 }
1696 return skip;
1697}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001698
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001699void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1700 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1701 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001702 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001703 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001704 if (cb_node && image_state) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07001705 AddCommandBufferBindingImage(cb_node, image_state);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001706 for (uint32_t i = 0; i < rangeCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06001707 SetImageInitialLayout(cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001708 }
1709 }
1710}
1711
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001712// Returns true if [x, xoffset] and [y, yoffset] overlap
1713static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1714 bool result = false;
1715 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1716 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1717
1718 if (intersection_max > intersection_min) {
1719 result = true;
1720 }
1721 return result;
1722}
1723
Dave Houltonc991cc92018-03-06 11:08:51 -07001724// Returns true if source area of first copy region intersects dest area of second region
1725// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1726static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001727 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001728
Dave Houltonc991cc92018-03-06 11:08:51 -07001729 // Separate planes within a multiplane image cannot intersect
1730 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001731 return result;
1732 }
1733
Dave Houltonc991cc92018-03-06 11:08:51 -07001734 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1735 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1736 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001737 result = true;
1738 switch (type) {
1739 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001740 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001741 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001742 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001743 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001744 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001745 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001746 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001747 break;
1748 default:
1749 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1750 assert(false);
1751 }
1752 }
1753 return result;
1754}
1755
Dave Houltonfc1a4052017-04-27 14:32:45 -06001756// Returns non-zero if offset and extent exceed image extents
1757static const uint32_t x_bit = 1;
1758static const uint32_t y_bit = 2;
1759static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001760static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001761 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001762 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001763 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1764 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001765 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001766 }
1767 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1768 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001769 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001770 }
1771 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1772 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001773 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001774 }
1775 return result;
1776}
1777
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001778// Test if two VkExtent3D structs are equivalent
1779static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1780 bool result = true;
1781 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1782 (extent->depth != other_extent->depth)) {
1783 result = false;
1784 }
1785 return result;
1786}
1787
Dave Houltonee281a52017-12-08 13:51:02 -07001788// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1789// Destination image texel extents must be adjusted by block size for the dest validation checks
1790VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1791 VkExtent3D adjusted_extent = extent;
1792 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001793 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001794 adjusted_extent.width /= block_size.width;
1795 adjusted_extent.height /= block_size.height;
1796 adjusted_extent.depth /= block_size.depth;
1797 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001798 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001799 adjusted_extent.width *= block_size.width;
1800 adjusted_extent.height *= block_size.height;
1801 adjusted_extent.depth *= block_size.depth;
1802 }
1803 return adjusted_extent;
1804}
1805
Dave Houlton6f9059e2017-05-02 17:15:13 -06001806// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001807static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1808 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001809
1810 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001811 if (mip >= img->createInfo.mipLevels) {
1812 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001813 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001814
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001815 // 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 -06001816 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001817
Dave Houltone48cd112019-01-03 17:01:18 -07001818 // If multi-plane, adjust per-plane extent
1819 if (FormatIsMultiplane(img->createInfo.format)) {
1820 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1821 extent.width /= divisors.width;
1822 extent.height /= divisors.height;
1823 }
1824
Jeff Bolzef40fec2018-09-01 22:04:34 -05001825 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1826 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001827 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001828 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1829 } else {
1830 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1831 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1832 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1833 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001834
Dave Houlton6f9059e2017-05-02 17:15:13 -06001835 // Image arrays have an effective z extent that isn't diminished by mip level
1836 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001837 extent.depth = img->createInfo.arrayLayers;
1838 }
1839
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001840 return extent;
1841}
1842
1843// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001844static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001845 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1846}
1847
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001848// Test if the extent argument has any dimensions set to 0.
1849static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1850 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1851}
1852
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001853// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001854VkExtent3D CoreChecks::GetScaledItg(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001855 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1856 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001857 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001858 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001859 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001860 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001861 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001862 granularity.width *= block_size.width;
1863 granularity.height *= block_size.height;
1864 }
1865 }
1866 return granularity;
1867}
1868
1869// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1870static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1871 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001872 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1873 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001874 valid = false;
1875 }
1876 return valid;
1877}
1878
1879// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001880bool CoreChecks::CheckItgOffset(const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset, const VkExtent3D *granularity,
1881 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001882 bool skip = false;
1883 VkExtent3D offset_extent = {};
1884 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1885 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1886 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001887 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001888 // 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 -07001889 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001890 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 -04001891 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001892 "%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 "
1893 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001894 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001895 }
1896 } else {
1897 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1898 // integer multiples of the image transfer granularity.
1899 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001900 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 -04001901 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001902 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1903 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001904 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1905 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001906 }
1907 }
1908 return skip;
1909}
1910
1911// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001912bool CoreChecks::CheckItgExtent(const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent, const VkOffset3D *offset,
1913 const VkExtent3D *granularity, const VkExtent3D *subresource_extent, const VkImageType image_type,
1914 const uint32_t i, const char *function, const char *member, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001915 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001916 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001917 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1918 // subresource extent.
1919 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001920 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 -04001921 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001922 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1923 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1924 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1925 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001926 }
1927 } else {
1928 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1929 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1930 // subresource extent dimensions.
1931 VkExtent3D offset_extent_sum = {};
1932 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1933 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1934 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001935 bool x_ok = true;
1936 bool y_ok = true;
1937 bool z_ok = true;
1938 switch (image_type) {
1939 case VK_IMAGE_TYPE_3D:
1940 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
1941 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001942 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001943 case VK_IMAGE_TYPE_2D:
1944 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
1945 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001946 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001947 case VK_IMAGE_TYPE_1D:
1948 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
1949 (subresource_extent->width == offset_extent_sum.width));
1950 break;
1951 default:
1952 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1953 assert(false);
1954 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06001955 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07001956 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 -04001957 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001958 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
1959 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
1960 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
1961 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
1962 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
1963 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001964 }
1965 }
1966 return skip;
1967}
1968
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001969bool CoreChecks::ValidateImageMipLevel(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, uint32_t mip_level, const uint32_t i,
1970 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001971 bool skip = false;
1972 if (mip_level >= img->createInfo.mipLevels) {
1973 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1974 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07001975 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
1976 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07001977 }
1978 return skip;
1979}
1980
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001981bool CoreChecks::ValidateImageArrayLayerRange(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img, const uint32_t base_layer,
1982 const uint32_t layer_count, const uint32_t i, const char *function,
1983 const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07001984 bool skip = false;
1985 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
1986 (base_layer + layer_count) > img->createInfo.arrayLayers) {
1987 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1988 HandleToUint64(cb_node->commandBuffer), vuid,
1989 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07001990 "%u, but provided image %s has %u array layers.",
1991 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
1992 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07001993 }
1994 return skip;
1995}
1996
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07001997// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07001998bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
1999 const VkBufferImageCopy *region, const uint32_t i,
2000 const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002001 bool skip = false;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002002 VkExtent3D granularity = GetScaledItg(cb_node, img);
2003 skip |= CheckItgOffset(cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
Cort Stratton420ebd42018-05-04 01:12:23 -04002004 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002005 skip |= CheckItgExtent(cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
Cort Stratton420ebd42018-05-04 01:12:23 -04002006 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002007 return skip;
2008}
2009
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002010// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002011bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *src_img,
2012 const IMAGE_STATE *dst_img, const VkImageCopy *region,
2013 const uint32_t i, const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002014 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002015 // Source image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002016 VkExtent3D granularity = GetScaledItg(cb_node, src_img);
2017 skip |=
2018 CheckItgOffset(cb_node, &region->srcOffset, &granularity, i, function, "srcOffset", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002019 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002020 const VkExtent3D extent = region->extent;
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002021 skip |= CheckItgExtent(cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent, src_img->createInfo.imageType,
2022 i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002023
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002024 // Destination image checks
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002025 granularity = GetScaledItg(cb_node, dst_img);
2026 skip |=
2027 CheckItgOffset(cb_node, &region->dstOffset, &granularity, i, function, "dstOffset", "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002028 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002029 const VkExtent3D dest_effective_extent =
2030 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002031 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002032 skip |= CheckItgExtent(cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002033 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002034 return skip;
2035}
2036
Dave Houlton6f9059e2017-05-02 17:15:13 -06002037// Validate contents of a VkImageCopy struct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002038bool CoreChecks::ValidateImageCopyData(const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002039 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002040 bool skip = false;
2041
2042 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002043 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002044
2045 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002046 const VkExtent3D src_copy_extent = region.extent;
2047 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002048 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2049
Dave Houlton6f9059e2017-05-02 17:15:13 -06002050 bool slice_override = false;
2051 uint32_t depth_slices = 0;
2052
2053 // Special case for copying between a 1D/2D array and a 3D image
2054 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2055 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002056 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002057 slice_override = (depth_slices != 1);
2058 } 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 -07002059 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002060 slice_override = (depth_slices != 1);
2061 }
2062
2063 // Do all checks on source image
2064 //
2065 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002066 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2067 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 -06002068 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002069 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002070 "be 0 and 1, respectively.",
2071 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002072 }
2073 }
2074
Dave Houlton533be9f2018-03-26 17:08:30 -06002075 // VUID-VkImageCopy-srcImage-01785
2076 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2077 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 -06002078 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002079 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002080 "these must be 0 and 1, respectively.",
2081 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002082 }
2083
Dave Houlton533be9f2018-03-26 17:08:30 -06002084 // VUID-VkImageCopy-srcImage-01787
2085 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2086 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 -06002087 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002088 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2089 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002090 }
2091
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002092 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002093 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002094 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002095 skip |=
2096 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002097 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002098 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002099 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2100 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002101 }
2102 }
2103 } else { // Pre maint 1
2104 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002105 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002106 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 -06002107 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002108 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2109 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002110 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2111 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002112 }
2113 }
2114 }
2115
Dave Houltonc991cc92018-03-06 11:08:51 -07002116 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002117 bool ext_ycbcr = device_extensions.vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002118 if (FormatIsCompressed(src_state->createInfo.format) ||
2119 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002120 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002122 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2123 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2124 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002125 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002126 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 -07002127 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002128 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002129 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002130 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 }
2132
Dave Houlton94a00372017-12-14 15:08:47 -07002133 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002134 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2135 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002136 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002137 skip |=
2138 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002139 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002140 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002141 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002142 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002143 }
2144
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002145 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002146 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2147 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002148 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002149 skip |=
2150 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002151 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002152 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002153 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002154 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002155 }
2156
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002157 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002158 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2159 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002160 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002161 skip |=
2162 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002163 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002164 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002165 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002166 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002167 }
2168 } // Compressed
2169
2170 // Do all checks on dest image
2171 //
2172 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002173 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002174 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 -06002175 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002176 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002177 "these must be 0 and 1, respectively.",
2178 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002179 }
2180 }
2181
Dave Houlton533be9f2018-03-26 17:08:30 -06002182 // VUID-VkImageCopy-dstImage-01786
2183 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2184 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 -06002185 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002186 "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 -06002187 "and 1, respectively.",
2188 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002189 }
2190
2191 // VUID-VkImageCopy-dstImage-01788
2192 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2193 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 -06002194 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002195 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2196 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002197 }
2198
2199 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002200 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 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 -06002202 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002203 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002204 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2205 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002206 }
2207 }
2208 // VU01199 changed with mnt1
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002209 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002210 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002211 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002212 skip |=
2213 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002214 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002215 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002216 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2217 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002218 }
2219 }
2220 } else { // Pre maint 1
2221 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002222 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002223 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 -06002224 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002225 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2226 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002227 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2228 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002229 }
2230 }
2231 }
2232
Dave Houltonc991cc92018-03-06 11:08:51 -07002233 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2234 if (FormatIsCompressed(dst_state->createInfo.format) ||
2235 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002236 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002237
2238 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002239 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2240 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2241 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002242 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 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 -07002244 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002245 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002246 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002247 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002248 }
2249
Dave Houlton94a00372017-12-14 15:08:47 -07002250 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002251 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2252 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002253 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002254 skip |=
2255 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002256 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002257 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002258 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002259 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002260 }
2261
Dave Houltonee281a52017-12-08 13:51:02 -07002262 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2263 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2264 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002265 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002266 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002267 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002268 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2269 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002270 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002271 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002272 }
2273
Dave Houltonee281a52017-12-08 13:51:02 -07002274 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2275 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2276 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002277 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002278 skip |=
2279 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002280 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002281 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002282 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002283 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002284 }
2285 } // Compressed
2286 }
2287 return skip;
2288}
2289
Dave Houltonc991cc92018-03-06 11:08:51 -07002290// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002291bool CoreChecks::CopyImageMultiplaneValidation(VkCommandBuffer command_buffer, const IMAGE_STATE *src_image_state,
2292 const IMAGE_STATE *dst_image_state, const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002293 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002294
2295 // Neither image is multiplane
2296 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2297 // If neither image is multi-plane the aspectMask member of src and dst must match
2298 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2299 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002300 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002301 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2302 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 -06002303 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002304 }
2305 } else {
2306 // Source image multiplane checks
2307 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2308 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2309 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2310 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002311 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002312 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 -06002313 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002314 }
2315 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2316 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2317 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002318 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002319 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 -06002320 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002321 }
2322 // Single-plane to multi-plane
2323 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2324 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2325 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002326 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002327 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 -06002328 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002329 }
2330
2331 // Dest image multiplane checks
2332 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2333 aspect = region.dstSubresource.aspectMask;
2334 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2335 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002336 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002337 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 -06002338 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002339 }
2340 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2341 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2342 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002343 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002344 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 -06002345 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002346 }
2347 // Multi-plane to single-plane
2348 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2349 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2350 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002351 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002352 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 -06002353 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002354 }
2355 }
2356
2357 return skip;
2358}
2359
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002360bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2361 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2362 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002363 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002364 auto src_image_state = GetImageState(srcImage);
2365 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002366 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002367
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002368 skip = ValidateImageCopyData(regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002369
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002370 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2371
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002372 for (uint32_t i = 0; i < regionCount; i++) {
2373 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002374
2375 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2376 VkExtent3D src_copy_extent = region.extent;
2377 VkExtent3D dst_copy_extent =
2378 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2379
Dave Houlton6f9059e2017-05-02 17:15:13 -06002380 bool slice_override = false;
2381 uint32_t depth_slices = 0;
2382
2383 // Special case for copying between a 1D/2D array and a 3D image
2384 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2385 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2386 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002387 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002388 slice_override = (depth_slices != 1);
2389 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2390 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002391 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002392 slice_override = (depth_slices != 1);
2393 }
2394
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002395 skip |= ValidateImageSubresourceLayers(cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2396 skip |= ValidateImageSubresourceLayers(cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
2397 skip |= ValidateImageMipLevel(cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002398 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002399 skip |= ValidateImageMipLevel(cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
Cort Strattonff1542a2018-05-27 10:49:28 -07002400 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002401 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002402 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2403 "VUID-vkCmdCopyImage-srcSubresource-01698");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002404 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002405 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2406 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002407
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002408 if (device_extensions.vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002409 // No chance of mismatch if we're overriding depth slice count
2410 if (!slice_override) {
2411 // The number of depth slices in srcSubresource and dstSubresource must match
2412 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2413 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002414 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2415 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002416 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002417 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2418 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002419 if (src_slices != dst_slices) {
2420 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002421 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002422 << "] do not match";
2423 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 -06002424 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002425 }
2426 }
2427 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002428 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002429 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002430 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002431 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002432 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002434 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002435 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002436 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002437
Dave Houltonc991cc92018-03-06 11:08:51 -07002438 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002439 if (device_extensions.vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002440 skip |= CopyImageMultiplaneValidation(command_buffer, src_image_state, dst_image_state, region);
Dave Houltonc991cc92018-03-06 11:08:51 -07002441 }
2442
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002443 if (!device_extensions.vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002444 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2445 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002446 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002447 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 -06002448 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002449 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002450 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002451
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002452 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002453 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002454 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002455 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002456 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2457 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 -06002458 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002459 }
2460
2461 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002462 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002463 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002464 ss << "vkCmdCopyImage(): pRegion[" << i
2465 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002466 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 -06002467 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002468 }
2469
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002470 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2471 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2472 // 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 -07002473 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2474 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002475 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002476 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002477 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2478 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2479 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002480 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002481 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002482 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002483
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002484 // 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 -07002485 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2486 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002487 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002488 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002489 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2490 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2491 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002492 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 -06002493 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002494 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002495 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002496
Dave Houltonfc1a4052017-04-27 14:32:45 -06002497 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002498 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2499 if (slice_override) src_copy_extent.depth = depth_slices;
2500 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002501 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002502 skip |=
2503 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2504 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2505 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2506 "width [%1d].",
2507 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002508 }
2509
2510 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002511 skip |=
2512 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2513 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2514 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2515 "height [%1d].",
2516 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002517 }
2518 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002519 skip |=
2520 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2521 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2522 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2523 "depth [%1d].",
2524 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002525 }
2526
Dave Houltonee281a52017-12-08 13:51:02 -07002527 // Adjust dest extent if necessary
2528 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2529 if (slice_override) dst_copy_extent.depth = depth_slices;
2530
2531 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002532 if (extent_check & x_bit) {
2533 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 -06002534 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002535 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002536 "width [%1d].",
2537 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002538 }
2539 if (extent_check & y_bit) {
2540 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 -06002541 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002542 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002543 "height [%1d].",
2544 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002545 }
2546 if (extent_check & z_bit) {
2547 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 -06002548 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002549 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002550 "depth [%1d].",
2551 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002552 }
2553
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002554 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2555 // must not overlap in memory
2556 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002557 for (uint32_t j = 0; j < regionCount; j++) {
2558 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002559 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002560 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002561 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002562 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 -06002563 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002564 }
2565 }
2566 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002567 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002568
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002569 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2570 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2571 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002572 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002573 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2574 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002575 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 -06002576 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002577 }
2578 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002579 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002580 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2581 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002582 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002583 }
2584 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002585
Dave Houlton33c22b72017-02-28 13:16:02 -07002586 // Source and dest image sample counts must match
2587 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2588 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2589 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 -06002590 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002591 }
2592
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002593 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2594 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002595 // Validate that SRC & DST images have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002596 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyImage-srcImage-00126",
2597 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2598 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyImage-dstImage-00131",
2599 "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002600 if (GetApiVersion() >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002601 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
2602 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
2603 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
2604 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002605 }
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002606 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdCopyImage()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002607 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002608 skip |= ValidateCmd(cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
2609 skip |= InsideRenderPass(cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002610 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002611 const char *invalid_src_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2612 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2613 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
2614 const char *invalid_dst_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
2615 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2616 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002617 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002618 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002619 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2620 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002621 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002622 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2623 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002624 skip |= ValidateCopyImageTransferGranularityRequirements(cb_node, src_image_state, dst_image_state, &pRegions[i], i,
2625 "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 }
2627
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002628 return skip;
2629}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002630
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002631void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2632 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2633 const VkImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002634 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002635 auto src_image_state = GetImageState(srcImage);
2636 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002637
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002638 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002639 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06002640 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2641 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002642 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002643 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002644 AddCommandBufferBindingImage(cb_node, src_image_state);
2645 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002646}
2647
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002648// Returns true if sub_rect is entirely contained within rect
2649static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2650 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2651 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2652 return false;
2653 return true;
2654}
2655
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002656bool CoreChecks::ValidateClearAttachmentExtent(VkCommandBuffer command_buffer, uint32_t attachment_index,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002657 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2658 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002659 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002660 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2661 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002662 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002663 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002664
2665 for (uint32_t j = 0; j < rect_count; j++) {
2666 if (!ContainsRect(render_area, clear_rects[j].rect)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002667 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 -07002668 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2669 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2670 "the current render pass instance.",
2671 j);
2672 }
2673
2674 if (image_view_state) {
2675 // The layers specified by a given element of pRects must be contained within every attachment that
2676 // pAttachments refers to
2677 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2678 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2679 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002680 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2681 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2682 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2683 "of pAttachment[%d].",
2684 j, attachment_index);
John Zulauf3a548ef2019-02-01 16:14:07 -07002685 }
2686 }
2687 }
2688 return skip;
2689}
2690
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002691bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2692 const VkClearAttachment *pAttachments, uint32_t rectCount,
2693 const VkClearRect *pRects) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002694 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002695
2696 bool skip = false;
2697 if (cb_node) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002698 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002699 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002700 skip |= ValidateCmd(cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002701 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002702 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002703 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2704 // 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 -07002705 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2706 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002707 skip |=
2708 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2709 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2710 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2711 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2712 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002713 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002714 skip |= OutsideRenderPass(cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002715 }
2716
2717 // Validate that attachment is in reference list of active subpass
2718 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002719 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002720 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002721 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002722 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002723 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2724 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002725
John Zulauf3a548ef2019-02-01 16:14:07 -07002726 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2727 auto clear_desc = &pAttachments[attachment_index];
2728 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002729
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002730 if (0 == clear_desc->aspectMask) {
2731 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 -06002732 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002733 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2734 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 -06002735 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002736 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002737 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2738 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2739 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2740 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002741 skip |= log_msg(
2742 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2743 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2744 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2745 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2746 attachment_index, clear_desc->colorAttachment,
2747 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2748 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2749
John Zulauff2582972019-02-09 14:53:30 -07002750 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2751 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002752 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002753 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2754 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2755 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2756 " subpass %u. colorAttachmentCount=%u",
2757 attachment_index, clear_desc->colorAttachment,
2758 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2759 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002760 }
John Zulauff2582972019-02-09 14:53:30 -07002761 fb_attachment = color_attachment;
2762
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002763 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2764 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2765 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002766 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002767 skip |=
2768 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2769 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002770 }
2771 } else { // Must be depth and/or stencil
2772 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2773 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002774 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002775 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 -07002776 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2777 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002778 }
2779 if (!subpass_desc->pDepthStencilAttachment ||
2780 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2781 skip |= log_msg(
2782 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002783 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002784 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002785 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002786 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002787 }
2788 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002789 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002790 skip |= ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2791 rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002792 } else {
2793 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2794 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2795 if (!clear_rect_copy) {
2796 // We need a copy of the clear rectangles that will persist until the last lambda executes
2797 // but we want to create it as lazily as possible
2798 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002799 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002800
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002801 auto val_fn = [this, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
John Zulauf3a548ef2019-02-01 16:14:07 -07002802 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2803 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002804 FRAMEBUFFER_STATE *framebuffer = GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002805 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2806 bool skip = false;
Mark Lobodzinskif933db92019-03-09 12:58:03 -07002807 skip = ValidateClearAttachmentExtent(commandBuffer, attachment_index, framebuffer, fb_attachment, render_area,
2808 rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002809 return skip;
2810 };
2811 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002812 }
2813 }
2814 }
2815 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002816}
2817
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002818bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2819 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2820 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002821 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002822 auto src_image_state = GetImageState(srcImage);
2823 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002824
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002825 bool skip = false;
2826 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002827 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-srcImage-00256");
2828 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-00258");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002829 skip |= ValidateCmdQueueFlags(cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002830 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002831 skip |= ValidateCmd(cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
2832 skip |= InsideRenderPass(cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002833 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT, "vkCmdResolveImage()",
2834 "VUID-vkCmdResolveImage-dstImage-02003", "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002835
Cort Stratton7df30962018-05-17 19:45:57 -07002836 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002837 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002838 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002839 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2840 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2841 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06002842 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002843 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2844 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002845 // For each region, the number of layers in the image subresource should not be zero
2846 // For each region, src and dest image aspect must be color only
2847 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002848 skip |=
2849 ValidateImageSubresourceLayers(cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()", "srcSubresource", i);
2850 skip |=
2851 ValidateImageSubresourceLayers(cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()", "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002852 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002853 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2854 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002855 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002856 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2857 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002858 skip |= ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i, "vkCmdResolveImage()",
2859 "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2860 skip |= ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i, "vkCmdResolveImage()",
2861 "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2862 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002863 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2864 "VUID-vkCmdResolveImage-srcSubresource-01711");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002865 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07002866 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2867 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002868
2869 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002870 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2871 skip |= log_msg(
2872 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002873 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002874 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002875 }
Cort Stratton7df30962018-05-17 19:45:57 -07002876 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002877 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2878 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2879 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002880 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002881 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 -06002882 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002883 }
2884 }
2885
2886 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2887 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002888 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 -06002889 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002890 }
2891 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2892 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
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_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002895 }
2896 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2897 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2898 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 -06002899 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002900 }
2901 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2902 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
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-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002905 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002906 } else {
2907 assert(0);
2908 }
2909 return skip;
2910}
2911
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002912void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2913 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2914 const VkImageResolve *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002915 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002916 auto src_image_state = GetImageState(srcImage);
2917 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002918
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002919 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002920 AddCommandBufferBindingImage(cb_node, src_image_state);
2921 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002922}
2923
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002924bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2925 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2926 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002927 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002928 auto src_image_state = GetImageState(srcImage);
2929 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002930
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002931 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07002932 if (cb_node) {
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002933 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
John Zulauf5c2750c2018-01-30 15:04:56 -07002934 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002935 if (cb_node && src_image_state && dst_image_state) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002936 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002937 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002938 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06002939 "VUID-vkCmdBlitImage-dstImage-00234");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07002940 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
2941 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
Dave Houltond8ed0212018-05-16 17:18:24 -06002942 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002943 ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdBlitImage-srcImage-00219",
2944 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06002945 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002946 ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdBlitImage-dstImage-00224",
2947 "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07002948 skip |=
2949 ValidateCmdQueueFlags(cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT, "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07002950 skip |= ValidateCmd(cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
2951 skip |= InsideRenderPass(cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002952 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002953 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002954 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002955 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04002956
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06002957 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07002958
Dave Houlton33c2d252017-06-09 17:08:32 -06002959 VkFormat src_format = src_image_state->createInfo.format;
2960 VkFormat dst_format = dst_image_state->createInfo.format;
2961 VkImageType src_type = src_image_state->createInfo.imageType;
2962 VkImageType dst_type = dst_image_state->createInfo.imageType;
2963
Cort Stratton186b1a22018-05-01 20:18:06 -04002964 if (VK_FILTER_LINEAR == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002965 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002966 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
2967 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04002968 } else if (VK_FILTER_CUBIC_IMG == filter) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07002969 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG,
2970 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02002",
2971 "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06002972 }
2973
2974 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
2975 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 -06002976 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002977 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002978 }
2979
Dave Houlton33c2d252017-06-09 17:08:32 -06002980 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
2981 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
2982 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 -06002983 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002984 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06002985 }
2986
2987 // Validate consistency for unsigned formats
2988 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
2989 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002990 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06002991 << "the other one must also have unsigned integer format. "
2992 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
2993 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 -06002994 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06002995 }
2996
2997 // Validate consistency for signed formats
2998 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
2999 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003000 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003001 << "the other one must also have signed integer format. "
3002 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3003 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 -06003004 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003005 }
3006
3007 // Validate filter for Depth/Stencil formats
3008 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3009 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003010 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003011 << "then filter must be VK_FILTER_NEAREST.";
3012 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 -06003013 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003014 }
3015
3016 // Validate aspect bits and formats for depth/stencil images
3017 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3018 if (src_format != dst_format) {
3019 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003020 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003021 << "stencil, the other one must have exactly the same format. "
3022 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3023 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003024 skip |=
3025 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3026 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003027 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003028 } // Depth or Stencil
3029
3030 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003031 const char *invalid_src_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003032 (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003033 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3034 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3035 const char *invalid_dst_layout_vuid =
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003036 (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003037 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3038 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003039 for (uint32_t i = 0; i < regionCount; i++) {
3040 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003041 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003042 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003043 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3044 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003045 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003046 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3047 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003048 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3049 skip |= ValidateImageSubresourceLayers(cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
3050 skip |= ValidateImageMipLevel(cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003051 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003052 skip |= ValidateImageMipLevel(cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
Cort Strattonff1542a2018-05-27 10:49:28 -07003053 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003054 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003055 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3056 "VUID-vkCmdBlitImage-srcSubresource-01707");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003057 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07003058 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3059 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003060 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003061 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3062 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003063 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003064 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003065 skip |=
3066 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3067 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003068 }
Dave Houlton48989f32017-05-26 15:01:46 -06003069 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3070 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003071 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003072 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003073 skip |=
3074 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3075 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003076 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003077
3078 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003079 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003080 skip |= log_msg(
3081 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3082 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3083 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003084 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003085
Dave Houlton48989f32017-05-26 15:01:46 -06003086 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003087 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 -06003088 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003089 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003090 }
Dave Houlton48989f32017-05-26 15:01:46 -06003091
Dave Houlton33c2d252017-06-09 17:08:32 -06003092 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3093 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003094 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003095 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003096 "image format %s.",
3097 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003098 }
3099
3100 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3101 skip |= log_msg(
3102 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003103 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003104 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3105 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003106 }
3107
Dave Houlton48989f32017-05-26 15:01:46 -06003108 // Validate source image offsets
3109 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003110 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003111 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003112 skip |=
3113 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3114 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3115 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3116 "of (%1d, %1d). These must be (0, 1).",
3117 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003118 }
3119 }
3120
Dave Houlton33c2d252017-06-09 17:08:32 -06003121 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003122 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3123 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 -06003124 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003125 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003126 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3127 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003128 }
3129 }
3130
Dave Houlton33c2d252017-06-09 17:08:32 -06003131 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003132 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3133 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003134 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003135 skip |= log_msg(
3136 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3137 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3138 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3139 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003140 }
3141 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3142 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003143 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003144 skip |= log_msg(
3145 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003146 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003147 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003148 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003149 }
3150 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3151 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003152 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003153 skip |= log_msg(
3154 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3155 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3156 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3157 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003158 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003159 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003160 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 -06003161 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003162 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003163 }
Dave Houlton48989f32017-05-26 15:01:46 -06003164
3165 // Validate dest image offsets
3166 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003167 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003168 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003169 skip |=
3170 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3171 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3172 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3173 "(%1d, %1d). These must be (0, 1).",
3174 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003175 }
3176 }
3177
Dave Houlton33c2d252017-06-09 17:08:32 -06003178 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003179 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3180 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 -06003181 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003182 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003183 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3184 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003185 }
3186 }
3187
Dave Houlton33c2d252017-06-09 17:08:32 -06003188 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003189 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3190 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003191 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003192 skip |= log_msg(
3193 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3194 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3195 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3196 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003197 }
3198 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3199 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003200 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003201 skip |= log_msg(
3202 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003203 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003204 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003205 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003206 }
3207 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3208 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003209 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003210 skip |= log_msg(
3211 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3212 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3213 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3214 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003215 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003216 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003217 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 -06003218 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003219 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003220 }
3221
Dave Houlton33c2d252017-06-09 17:08:32 -06003222 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3223 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3224 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003225 skip |=
3226 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3227 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3228 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3229 "layerCount other than 1.",
3230 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003231 }
3232 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003233 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003234 } else {
3235 assert(0);
3236 }
3237 return skip;
3238}
3239
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003240void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3241 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3242 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003243 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003244 auto src_image_state = GetImageState(srcImage);
3245 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003246
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003247 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003248 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06003249 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3250 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003251 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003252 // Update bindings between images and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07003253 AddCommandBufferBindingImage(cb_node, src_image_state);
3254 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003255}
3256
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003257// 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 -07003258bool CoreChecks::ValidateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003259 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3260 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003261 bool skip = false;
John Zulauff660ad62019-03-23 07:16:05 -06003262 // Iterate over the layout maps for each referenced image
3263 for (const auto &layout_map_entry : pCB->image_layout_map) {
3264 const auto image = layout_map_entry.first;
3265 const auto *image_state = GetImageState(image);
3266 if (!image_state) continue; // Can't check layouts of a dead image
3267 const auto &subres_map = layout_map_entry.second;
3268 ImageSubresourcePair isr_pair;
3269 isr_pair.image = image;
3270 isr_pair.hasSubresource = true;
Tony Barbourdf013b92017-01-25 12:53:48 -07003271
John Zulauff660ad62019-03-23 07:16:05 -06003272 // Validate the initial_uses for each subresource referenced
3273 for (auto it_init = subres_map->BeginInitialUse(); !it_init.AtEnd(); ++it_init) {
3274 isr_pair.subresource = (*it_init).subresource;
3275 VkImageLayout initial_layout = (*it_init).layout;
3276 VkImageLayout image_layout;
3277 if (FindLayout(overlayLayoutMap, isr_pair, image_layout) || FindLayout(globalImageLayoutMap, isr_pair, image_layout)) {
3278 if (initial_layout == VK_IMAGE_LAYOUT_UNDEFINED) {
3279 // TODO: Set memory invalid which is in mem_tracker currently
3280 } else if (image_layout != initial_layout) {
John Zulaufb61ed972019-04-09 16:12:35 -06003281 // Need to look up the inital layout *state* to get a bit more information
3282 const auto *initial_layout_state = subres_map->GetSubresourceInitialLayoutState(isr_pair.subresource);
3283 assert(initial_layout_state); // There's no way we should have an initial layout without matching state...
3284 bool matches = ImageLayoutMatches(initial_layout_state->aspect_mask, image_layout, initial_layout);
3285 if (!matches) {
3286 std::string formatted_label = FormatDebugLabel(" ", pCB->debug_label);
3287 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3288 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3289 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, "
3290 "mip level %u) "
3291 "to be in layout %s--instead, current layout is %s.%s",
3292 report_data->FormatHandle(image).c_str(), isr_pair.subresource.aspectMask,
3293 isr_pair.subresource.arrayLayer, isr_pair.subresource.mipLevel,
3294 string_VkImageLayout(initial_layout), string_VkImageLayout(image_layout),
3295 formatted_label.c_str());
3296 }
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003297 }
3298 }
John Zulauff660ad62019-03-23 07:16:05 -06003299 }
3300
3301 // Update all layout set operations (which will be a subset of the initial_layouts
3302 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3303 VkImageLayout layout = (*it_set).layout;
3304 isr_pair.subresource = (*it_set).subresource;
3305 SetLayout(overlayLayoutMap, isr_pair, layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003306 }
3307 }
John Zulauff660ad62019-03-23 07:16:05 -06003308
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003309 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003310}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003311
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003312void CoreChecks::UpdateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB) {
John Zulauff660ad62019-03-23 07:16:05 -06003313 for (const auto &layout_map_entry : pCB->image_layout_map) {
3314 const auto image = layout_map_entry.first;
3315 const auto *image_state = GetImageState(image);
3316 if (!image_state) continue; // Can't set layouts of a dead image
3317 const auto &subres_map = layout_map_entry.second;
3318 ImageSubresourcePair isr_pair;
3319 isr_pair.image = image;
3320 isr_pair.hasSubresource = true;
3321
3322 // Update all layout set operations (which will be a subset of the initial_layouts
3323 for (auto it_set = subres_map->BeginSetLayout(); !it_set.AtEnd(); ++it_set) {
3324 VkImageLayout layout = (*it_set).layout;
3325 isr_pair.subresource = (*it_set).subresource;
3326 SetGlobalLayout(isr_pair, layout);
3327 }
Tony Barbourdf013b92017-01-25 12:53:48 -07003328 }
3329}
3330
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003331// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003332// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3333// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003334bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3335 const VkImageLayout first_layout, const uint32_t attachment,
3336 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003337 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003338 const char *vuid;
3339 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3340
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003341 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3342 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003343 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3344 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3345 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003346 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003347 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3348 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3349 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3350 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3351 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3352 skip |=
3353 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3354 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003355 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003356 }
3357 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003358 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3359 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003360 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003361 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003362 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 -06003363 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003364 }
3365 }
3366
3367 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3368 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003369 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003370 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003371 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 -06003372 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003373 }
3374 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003375 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003376}
3377
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003378bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003379 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003380 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003381 const char *vuid;
3382 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3383 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003384
Jason Ekstranda1906302017-12-03 20:16:32 -08003385 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3386 VkFormat format = pCreateInfo->pAttachments[i].format;
3387 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3388 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3389 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003390 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 -06003391 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003392 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3393 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3394 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3395 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003396 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003397 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003398 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 -06003399 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003400 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3401 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3402 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3403 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003404 }
3405 }
3406 }
3407
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003408 // Track when we're observing the first use of an attachment
3409 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3410 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003411 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003412
3413 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3414 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3415 auto attach_index = subpass.pInputAttachments[j].attachment;
3416 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003417 switch (subpass.pInputAttachments[j].layout) {
3418 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3419 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3420 // These are ideal.
3421 break;
3422
3423 case VK_IMAGE_LAYOUT_GENERAL:
3424 // May not be optimal. TODO: reconsider this warning based on other constraints.
3425 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003426 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003427 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3428 break;
3429
Tobias Hectorbbb12282018-10-22 15:17:59 +01003430 case VK_IMAGE_LAYOUT_UNDEFINED:
3431 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3432 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3434 "Layout for input attachment reference %u in subpass %u is %s but must be "
3435 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3436 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3437 break;
3438
Graeme Leese668a9862018-10-08 10:40:02 +01003439 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3440 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003441 if (device_extensions.vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003442 break;
3443 } else {
3444 // Intentionally fall through to generic error message
3445 }
3446 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003447
Cort Stratton7547f772017-05-04 15:18:52 -07003448 default:
3449 // No other layouts are acceptable
3450 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 -06003451 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003452 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3453 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3454 }
3455
Cort Stratton7547f772017-05-04 15:18:52 -07003456 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003457 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3458 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003459
3460 bool used_as_depth =
3461 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3462 bool used_as_color = false;
3463 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3464 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3465 }
3466 if (!used_as_depth && !used_as_color &&
3467 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003468 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3469 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3470 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3471 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003472 }
3473 }
3474 attach_first_use[attach_index] = false;
3475 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003476
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003477 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3478 auto attach_index = subpass.pColorAttachments[j].attachment;
3479 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3480
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003481 // TODO: Need a way to validate shared presentable images here, currently just allowing
3482 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3483 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003484 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003485 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003486 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003487 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3488 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003489 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003490
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003491 case VK_IMAGE_LAYOUT_GENERAL:
3492 // May not be optimal; TODO: reconsider this warning based on other constraints?
3493 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003494 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003495 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3496 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003497
Tobias Hectorbbb12282018-10-22 15:17:59 +01003498 case VK_IMAGE_LAYOUT_UNDEFINED:
3499 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3500 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3501 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3502 "Layout for color attachment reference %u in subpass %u is %s but should be "
3503 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3504 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3505 break;
3506
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003507 default:
3508 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 -06003509 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003510 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3511 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003512 }
3513
John Zulauf4eee2692019-02-09 16:14:25 -07003514 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3515 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3516 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003517 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3518 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 -07003519 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003520 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003521 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003522 }
3523
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003524 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003525 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3526 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003527 }
3528 attach_first_use[attach_index] = false;
3529 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003530
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003531 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3532 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003533 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3534 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3535 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003536 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003537
Dave Houltona9df0ce2018-02-07 10:51:23 -07003538 case VK_IMAGE_LAYOUT_GENERAL:
3539 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3540 // doing a bunch of transitions.
3541 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003542 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003543 "GENERAL layout for depth attachment may not give optimal performance.");
3544 break;
3545
Tobias Hectorbbb12282018-10-22 15:17:59 +01003546 case VK_IMAGE_LAYOUT_UNDEFINED:
3547 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3548 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3549 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3550 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3551 "layout or GENERAL.",
3552 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3553 break;
3554
Dave Houltona9df0ce2018-02-07 10:51:23 -07003555 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3556 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06003557 if (device_extensions.vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003558 break;
3559 } else {
3560 // Intentionally fall through to generic error message
3561 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003562 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003563
Dave Houltona9df0ce2018-02-07 10:51:23 -07003564 default:
3565 // No other layouts are acceptable
3566 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 -06003567 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003568 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3569 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3570 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003571 }
3572
3573 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3574 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003575 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3576 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003577 }
3578 attach_first_use[attach_index] = false;
3579 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003580 }
3581 return skip;
3582}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003583
3584// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003585bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEM_INFO const *mem_info, VkDeviceSize offset,
3586 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003587 bool skip = false;
3588 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3589 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003590 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3591 for (auto image_handle : mem_info->bound_images) {
3592 auto img_it = mem_info->bound_ranges.find(image_handle);
3593 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003594 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003595 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003596 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003597 for (auto layout : layouts) {
3598 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003599 skip |=
3600 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 -06003601 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003602 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3603 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003604 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003605 }
3606 }
3607 }
3608 }
3609 }
3610 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003611 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003612}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003613
3614// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3615// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003616bool CoreChecks::ValidateUsageFlags(VkFlags actual, VkFlags desired, VkBool32 strict, uint64_t obj_handle,
3617 VulkanObjectType obj_type, const char *msgCode, char const *func_name, char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003618 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003619 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003620 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003621 if (strict) {
3622 correct_usage = ((actual & desired) == desired);
3623 } else {
3624 correct_usage = ((actual & desired) != 0);
3625 }
3626 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003627 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003628 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003629 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3630 kVUID_Core_MemTrack_InvalidUsageFlag,
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 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003634 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3635 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3636 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003637 }
3638 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003639 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003640}
3641
3642// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3643// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003644bool CoreChecks::ValidateImageUsageFlags(IMAGE_STATE const *image_state, VkFlags desired, bool strict, const char *msgCode,
3645 char const *func_name, char const *usage_string) {
3646 return ValidateUsageFlags(image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003647 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003648}
3649
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003650bool CoreChecks::ValidateImageFormatFeatureFlags(IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003651 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003652 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003653 bool skip = false;
3654 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3655 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003656 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3657 HandleToUint64(image_state->image), linear_vuid,
3658 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3659 format_properties.linearTilingFeatures, image_state->createInfo.format,
3660 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003661 }
3662 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3663 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3664 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3665 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003666 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003667 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003668 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003669 }
3670 }
3671 return skip;
3672}
3673
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003674bool CoreChecks::ValidateImageSubresourceLayers(const GLOBAL_CB_NODE *cb_node, const VkImageSubresourceLayers *subresource_layers,
3675 char const *func_name, char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003676 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003677 // layerCount must not be zero
3678 if (subresource_layers->layerCount == 0) {
3679 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3680 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3681 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3682 }
3683 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3684 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3685 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3686 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3687 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3688 }
3689 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3690 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3691 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3692 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3693 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3694 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3695 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3696 func_name, i, member);
3697 }
3698 return skip;
3699}
3700
Mark Lobodzinski96210742017-02-09 10:33:46 -07003701// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3702// where an error will be flagged if usage is not correct
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003703bool CoreChecks::ValidateBufferUsageFlags(BUFFER_STATE const *buffer_state, VkFlags desired, bool strict, const char *msgCode,
3704 char const *func_name, char const *usage_string) {
3705 return ValidateUsageFlags(buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003706 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003707}
3708
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003709bool CoreChecks::ValidateBufferViewRange(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo,
3710 const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003711 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003712
3713 const VkDeviceSize &range = pCreateInfo->range;
3714 if (range != VK_WHOLE_SIZE) {
3715 // Range must be greater than 0
3716 if (range <= 0) {
3717 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3718 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3719 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3720 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3721 range);
3722 }
3723 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003724 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003725 if (range % format_size != 0) {
3726 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3727 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3728 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3729 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3730 "(" PRINTF_SIZE_T_SPECIFIER ").",
3731 range, format_size);
3732 }
3733 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3734 if (range / format_size > device_limits->maxTexelBufferElements) {
3735 skip |=
3736 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3737 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3738 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3739 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3740 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3741 range, format_size, device_limits->maxTexelBufferElements);
3742 }
3743 // The sum of range and offset must be less than or equal to the size of buffer
3744 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3745 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3746 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3747 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3748 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3749 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3750 range, pCreateInfo->offset, buffer_state->createInfo.size);
3751 }
3752 }
3753 return skip;
3754}
3755
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003756bool CoreChecks::ValidateBufferViewBuffer(const BUFFER_STATE *buffer_state, const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003757 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003758 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003759 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3760 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3761 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3762 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3763 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3764 "be supported for uniform texel buffers");
3765 }
3766 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3767 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3768 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3769 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3770 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3771 "be supported for storage texel buffers");
3772 }
3773 return skip;
3774}
3775
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003776bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3777 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003778 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003779
Dave Houltond8ed0212018-05-16 17:18:24 -06003780 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003781
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003782 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!enabled_features.core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003783 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 -06003784 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003785 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003786 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003787 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003788
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003789 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!enabled_features.core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003790 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 -06003791 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003792 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003793 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003794 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003795
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003796 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!enabled_features.core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003797 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 -06003798 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003799 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003800 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003801 }
Jeff Bolz87697532019-01-11 22:54:00 -06003802
3803 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3804 if (chained_devaddr_struct) {
3805 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3806 chained_devaddr_struct->deviceAddress != 0) {
3807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3808 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3809 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3810 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3811 }
3812 }
3813
3814 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003815 !enabled_features.buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003816 skip |= log_msg(
3817 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3818 "VUID-VkBufferCreateInfo-flags-02605",
3819 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3820 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3821 }
3822
3823 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinskid7b03cc2019-04-19 14:23:10 -06003824 !enabled_features.buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003825 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3826 "VUID-VkBufferCreateInfo-usage-02606",
3827 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3828 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3829 }
3830
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003831 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07003832 skip |= ValidateQueueFamilies(pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices, "vkCreateBuffer",
3833 "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3834 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003835 }
3836
Mark Lobodzinski96210742017-02-09 10:33:46 -07003837 return skip;
3838}
3839
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003840void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3841 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003842 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003843 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06003844 bufferMap.insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003845}
3846
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003847bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3848 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003849 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003850 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003851 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3852 if (buffer_state) {
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07003853 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCreateBufferView()", "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003854 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3855 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003856 skip |= ValidateBufferUsageFlags(buffer_state,
Dave Houltond8ed0212018-05-16 17:18:24 -06003857 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3858 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3859 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003860
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003861 // Buffer view offset must be less than the size of buffer
3862 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3863 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3864 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3865 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3866 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3867 pCreateInfo->offset, buffer_state->createInfo.size);
3868 }
3869
Mark Lobodzinski79b5d5b2019-04-19 12:27:10 -06003870 const VkPhysicalDeviceLimits *device_limits = &phys_dev_props.limits;
Shannon McPherson883f6092018-06-14 13:15:25 -06003871 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3872 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3873 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3874 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3875 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3876 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3877 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3878 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003879
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003880 skip |= ValidateBufferViewRange(buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003881
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07003882 skip |= ValidateBufferViewBuffer(buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003883 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003884 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003885}
3886
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003887void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3888 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003889 if (result != VK_SUCCESS) return;
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06003890 bufferViewMap[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003891}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003892
3893// For the given format verify that the aspect masks make sense
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003894bool CoreChecks::ValidateImageAspectMask(VkImage image, VkFormat format, VkImageAspectFlags aspect_mask, const char *func_name,
3895 const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003896 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003897 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3898 if (image != VK_NULL_HANDLE) {
3899 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3900 }
3901
Dave Houlton1d2022c2017-03-29 11:43:58 -06003902 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003903 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003904 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003905 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003906 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003907 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003908 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003909 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003910 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003911 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003912 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003913 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003914 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3915 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003916 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003917 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003918 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003919 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3920 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003921 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003922 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003923 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003924 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003925 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003926 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003927 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003928 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003929 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003930 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003931 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003932 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003933 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003934 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003935 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003936 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003937 }
Dave Houlton501b15b2018-03-30 15:07:41 -06003938 } else if (FormatIsMultiplane(format)) {
3939 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
3940 if (3 == FormatPlaneCount(format)) {
3941 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
3942 }
3943 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003944 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06003945 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
3946 "set, where n = [0, 1, 2].",
3947 func_name);
3948 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003949 }
3950 return skip;
3951}
3952
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07003953bool CoreChecks::ValidateImageSubresourceRange(const uint32_t image_mip_count, const uint32_t image_layer_count,
3954 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
3955 const char *param_name, const char *image_layer_count_var_name,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003956 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003957 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02003958
3959 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02003960 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003961 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 -06003962 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003963 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003964 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
3965 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003966 }
Petr Kraus4d718682017-05-18 03:38:41 +02003967
Petr Krausffa94af2017-08-08 21:46:02 +02003968 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
3969 if (subresourceRange.levelCount == 0) {
3970 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 -06003971 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003972 } else {
3973 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02003974
Petr Krausffa94af2017-08-08 21:46:02 +02003975 if (necessary_mip_count > image_mip_count) {
3976 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 -06003977 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02003978 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003979 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02003980 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003981 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003982 }
Petr Kraus4d718682017-05-18 03:38:41 +02003983 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07003984 }
Petr Kraus4d718682017-05-18 03:38:41 +02003985
3986 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02003987 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003988 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 -06003989 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003990 "%s: %s.baseArrayLayer (= %" PRIu32
3991 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
3992 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02003993 }
Petr Kraus4d718682017-05-18 03:38:41 +02003994
Petr Krausffa94af2017-08-08 21:46:02 +02003995 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
3996 if (subresourceRange.layerCount == 0) {
3997 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 -06003998 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02003999 } else {
4000 const uint64_t necessary_layer_count =
4001 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004002
Petr Krausffa94af2017-08-08 21:46:02 +02004003 if (necessary_layer_count > image_layer_count) {
4004 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 -06004005 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004006 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004007 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004008 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004009 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004010 }
Petr Kraus4d718682017-05-18 03:38:41 +02004011 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004012 }
Petr Kraus4d718682017-05-18 03:38:41 +02004013
Mark Lobodzinski602de982017-02-09 11:01:33 -07004014 return skip;
4015}
4016
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004017bool CoreChecks::ValidateCreateImageViewSubresourceRange(const IMAGE_STATE *image_state, bool is_imageview_2d_type,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004018 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004019 bool is_khr_maintenance1 = device_extensions.vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004020 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4021 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4022 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4023
4024 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4025 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4026
4027 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004028 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4029 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4030 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4031 : "VUID-VkImageViewCreateInfo-image-01482")
4032 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4033 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4034 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4035 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4036 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004037
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004038 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
Petr Krausffa94af2017-08-08 21:46:02 +02004039 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4040 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4041}
4042
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004043bool CoreChecks::ValidateCmdClearColorSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004044 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004045 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004046 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4047 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4048 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4049 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004050
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004051 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4052 "vkCmdClearColorImage", param_name, "arrayLayers", HandleToUint64(image_state->image),
4053 subresourceRangeErrorCodes);
Petr Krausffa94af2017-08-08 21:46:02 +02004054}
4055
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004056bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004057 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004058 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004059 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4060 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4061 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4062 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004063
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004064 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4065 "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
Petr Krausffa94af2017-08-08 21:46:02 +02004066 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4067}
4068
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004069bool CoreChecks::ValidateImageBarrierSubresourceRange(const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004070 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4071 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004072 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004073 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4074 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4075 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4076 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004077
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004078 return ValidateImageSubresourceRange(image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers, subresourceRange,
4079 cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
Petr Krausffa94af2017-08-08 21:46:02 +02004080 subresourceRangeErrorCodes);
4081}
4082
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004083bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4084 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004085 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004086 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004087 if (image_state) {
4088 skip |= ValidateImageUsageFlags(
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004089 image_state,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004090 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004091 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4092 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004093 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004094 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004095 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004096 skip |= ValidateMemoryIsBoundToImage(image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004097 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004098 skip |= ValidateCreateImageViewSubresourceRange(
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004099 image_state, pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004100 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004101
4102 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4103 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004104 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4105 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004106 VkFormat view_format = pCreateInfo->format;
4107 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004108 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004109 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004110
Dave Houltonbd2e2622018-04-10 16:41:14 -06004111 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004112 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004113 if (chained_ivuci_struct) {
Dave Houltonbd2e2622018-04-10 16:41:14 -06004114 image_usage = chained_ivuci_struct->usage;
4115 }
4116
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004117 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4118 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004119 if (FormatIsMultiplane(image_format)) {
4120 // View format must match the multiplane compatible format
4121 uint32_t plane = 3; // invalid
4122 switch (aspect_mask) {
4123 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4124 plane = 0;
4125 break;
4126 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4127 plane = 1;
4128 break;
4129 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4130 plane = 2;
4131 break;
4132 default:
4133 break;
4134 }
4135
4136 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4137 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004138 std::stringstream ss;
4139 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004140 << " is not compatible with plane " << plane << " of underlying image format "
4141 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004142 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 -07004143 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004144 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004145 }
4146 } else {
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004147 if ((!device_extensions.vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004148 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4149 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4150 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4151 std::stringstream ss;
4152 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004153 << " is not in the same format compatibility class as image ("
4154 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004155 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4156 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004157 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 -07004158 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004159 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004160 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004161 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004162 }
4163 } else {
4164 // Format MUST be IDENTICAL to the format the image was created with
4165 if (image_format != view_format) {
4166 std::stringstream ss;
4167 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004168 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004169 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004170 skip |=
4171 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004172 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004173 }
4174 }
4175
4176 // Validate correct image aspect bits for desired formats and format consistency
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004177 skip |= ValidateImageAspectMask(image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004178
4179 switch (image_type) {
4180 case VK_IMAGE_TYPE_1D:
4181 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004182 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 -07004183 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004184 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4185 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004186 }
4187 break;
4188 case VK_IMAGE_TYPE_2D:
4189 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4190 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4191 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004192 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 -07004193 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004194 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4195 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004196 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004197 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 -07004198 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004199 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4200 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004201 }
4202 }
4203 break;
4204 case VK_IMAGE_TYPE_3D:
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004205 if (device_extensions.vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004206 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4207 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4208 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004209 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004210 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004211 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004212 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4213 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004214 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4215 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004216 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004217 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004218 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004219 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4220 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004221 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4222 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004223 }
4224 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004225 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 -07004226 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004227 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4228 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004229 }
4230 }
4231 } else {
4232 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004233 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 -07004234 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004235 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4236 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004237 }
4238 }
4239 break;
4240 default:
4241 break;
4242 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004243
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004244 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004245 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004246 skip |= ValidateCreateImageViewANDROID(pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004247 }
4248
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004249 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004250 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4251 : format_properties.optimalTilingFeatures;
4252
4253 if (tiling_features == 0) {
4254 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 -07004255 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004256 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4257 "physical device.",
4258 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4259 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
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-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004262 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4263 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4264 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4265 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_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-02275",
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_STORAGE_BIT.",
4270 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4271 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4272 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4273 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 -07004274 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004275 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4276 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4277 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4278 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4279 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4280 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 -07004281 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004282 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4283 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4284 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004285 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004286
Jeff Bolz9af91c52018-09-01 21:53:57 -05004287 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4288 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4289 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004290 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004291 "vkCreateImageView() If image was created with usage containing "
4292 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4293 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4294 }
4295 if (view_format != VK_FORMAT_R8_UINT) {
4296 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 -07004297 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004298 "vkCreateImageView() If image was created with usage containing "
4299 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4300 }
4301 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004302 }
4303 return skip;
4304}
4305
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004306void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4307 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004308 if (result != VK_SUCCESS) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004309 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004310 imageViewMap[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(image_state, *pView, pCreateInfo));
Mark Lobodzinski602de982017-02-09 11:01:33 -07004311}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004312
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004313bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4314 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004315 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004316 auto src_buffer_state = GetBufferState(srcBuffer);
4317 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004318
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004319 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004320 skip |= ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4321 skip |= ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004322 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004323 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004324 ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true, "VUID-vkCmdCopyBuffer-srcBuffer-00118",
4325 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Dave Houltond8ed0212018-05-16 17:18:24 -06004326 skip |=
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004327 ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdCopyBuffer-dstBuffer-00120",
4328 "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004329 skip |=
4330 ValidateCmdQueueFlags(cb_node, "vkCmdCopyBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4331 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004332 skip |= ValidateCmd(cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
4333 skip |= InsideRenderPass(cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004334 return skip;
4335}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004336
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004337void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4338 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004339 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004340 auto src_buffer_state = GetBufferState(srcBuffer);
4341 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004342
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004343 // Update bindings between buffers and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004344 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4345 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004346}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004347
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004348bool CoreChecks::ValidateIdleBuffer(VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004349 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004350 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004351 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004352 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 -07004353 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4354 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004355 } else {
4356 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004357 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 -06004358 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004359 "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 -07004360 }
4361 }
4362 return skip;
4363}
4364
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004365bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004366 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004367 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4368
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004369 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004370 if (image_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004371 skip |=
4372 ValidateObjectNotInUse(image_view_state, obj_struct, "vkDestroyImageView", "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004373 }
4374 return skip;
4375}
4376
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004377void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004378 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004379 if (!image_view_state) return;
4380 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4381
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004382 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004383 InvalidateCommandBuffers(image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski81b02a12019-04-19 13:58:43 -06004384 imageViewMap.erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004385}
4386
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004387bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004388 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004389
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004390 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004391 if (buffer_state) {
Mark Lobodzinskif933db92019-03-09 12:58:03 -07004392 skip |= ValidateIdleBuffer(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004393 }
4394 return skip;
4395}
4396
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004397void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004398 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004399 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004400 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4401
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004402 InvalidateCommandBuffers(buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004403 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004404 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004405 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004406 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004407 }
4408 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004409 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004410 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(buffer);
Mark Lobodzinski3baa8172019-04-19 13:47:30 -06004411 bufferMap.erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004412}
4413
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004414bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4415 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004416 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004417 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004418 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004419 if (buffer_view_state) {
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004420 skip |= ValidateObjectNotInUse(buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004421 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004422 }
4423 return skip;
4424}
4425
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004426void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004427 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004428 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004429 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4430
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004431 // Any bound cmd buffers are now invalid
Mark Lobodzinski9ddb7182019-03-08 17:31:09 -07004432 InvalidateCommandBuffers(buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskie0befe42019-04-19 13:49:08 -06004433 bufferViewMap.erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004434}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004435
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004436bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4437 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004438 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004439 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004440 bool skip = false;
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004441 skip |= ValidateMemoryIsBoundToBuffer(buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mark Lobodzinskidaea5912019-03-07 14:47:09 -07004442 skip |=
4443 ValidateCmdQueueFlags(cb_node, "vkCmdFillBuffer()", VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4444 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004445 skip |= ValidateCmd(cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004446 // Validate that DST buffer has correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004447 skip |= ValidateBufferUsageFlags(buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true, "VUID-vkCmdFillBuffer-dstBuffer-00029",
4448 "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004449 skip |= InsideRenderPass(cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004450 return skip;
4451}
4452
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004453void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4454 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004455 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004456 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004457 // Update bindings between buffer and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004458 AddCommandBufferBindingBuffer(cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004459}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004460
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004461bool CoreChecks::ValidateBufferImageCopyData(uint32_t regionCount, const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state,
4462 const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004463 bool skip = false;
4464
4465 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004466 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4467 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004468 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 -06004469 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004470 "%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 -06004471 "and 1, respectively.",
4472 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004473 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004474 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004475
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004476 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4477 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004478 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 -06004479 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004480 "%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 -06004481 "must be 0 and 1, respectively.",
4482 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004483 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004484 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004485
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004486 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4487 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004488 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 -06004489 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004490 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4491 "For 3D images these must be 0 and 1, respectively.",
4492 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004493 }
4494 }
4495
4496 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004497 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
Locke497739c2019-03-08 11:50:47 -07004498 uint32_t element_size = FormatElementSize(image_state->createInfo.format, pRegions[i].imageSubresource.aspectMask);
4499
Dave Houltona585d132019-01-18 13:05:42 -07004500 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004501 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 -06004502 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004503 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004504 " must be a multiple of this format's texel size (%" PRIu32 ").",
4505 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004506 }
4507
4508 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004509 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004510 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004511 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004512 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4513 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004514 }
4515
4516 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4517 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004518 skip |=
4519 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004520 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004521 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4522 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004523 }
4524
4525 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4526 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4527 skip |= log_msg(
4528 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004529 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004530 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4531 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004532 }
4533
4534 // subresource aspectMask must have exactly 1 bit set
4535 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4536 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4537 if (aspect_mask_bits.count() != 1) {
4538 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 -06004539 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004540 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004541 }
4542
4543 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004544 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004545 skip |= log_msg(
4546 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004547 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004548 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4549 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004550 }
4551
4552 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004553 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004554 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004555
4556 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004557 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004558 skip |= log_msg(
4559 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004560 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004561 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4562 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004563 }
4564
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004565 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004566 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004567 skip |= log_msg(
4568 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004569 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004570 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4571 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004572 }
4573
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004574 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004575 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4576 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4577 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004578 skip |=
4579 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004580 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004581 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4582 "width & height (%d, %d)..",
4583 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004584 }
4585
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004586 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004587 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004588 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004589 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 -06004590 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004591 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004592 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004593 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004594 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004595
4596 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004597 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004598 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004599 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4600 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 -06004601 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004602 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004603 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004604 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004605 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004606 }
4607
4608 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004609 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004610 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4611 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 -06004612 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004613 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004614 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004615 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004616 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004617 }
4618
4619 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004620 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004621 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4622 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 -06004623 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004624 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004625 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004626 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004627 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004628 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004629 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004630 }
4631
4632 return skip;
4633}
4634
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004635static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004636 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004637 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004638 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004639
4640 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004641 VkExtent3D extent = pRegions[i].imageExtent;
4642 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004643
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004644 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4645 {
Dave Houlton51653902018-06-22 17:32:13 -06004646 skip |=
4647 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4648 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4649 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004650 }
4651
4652 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4653
4654 // 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 -06004655 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004656 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004657 if (image_extent.width % block_extent.width) {
4658 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4659 }
4660 if (image_extent.height % block_extent.height) {
4661 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4662 }
4663 if (image_extent.depth % block_extent.depth) {
4664 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4665 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004666 }
4667
Dave Houltonfc1a4052017-04-27 14:32:45 -06004668 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004669 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 -06004670 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004671 }
4672 }
4673
4674 return skip;
4675}
4676
Chris Forbese8ba09a2017-06-01 17:39:02 -07004677static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004678 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004679 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004680 bool skip = false;
4681
4682 VkDeviceSize buffer_size = buff_state->createInfo.size;
4683
4684 for (uint32_t i = 0; i < regionCount; i++) {
4685 VkExtent3D copy_extent = pRegions[i].imageExtent;
4686
4687 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4688 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Locke497739c2019-03-08 11:50:47 -07004689 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format,
4690 pRegions[i].imageSubresource.aspectMask); // size (bytes) of texel or block
Dave Houltonf3229d52017-02-21 15:59:08 -07004691
Tom Cooperb2550c72018-10-15 13:08:41 +01004692 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004693 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004694 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004695 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4696 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4697
4698 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4699 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4700 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004701 }
4702
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004703 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4704 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4705 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004706 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004707 } else {
4708 // Calculate buffer offset of final copied byte, + 1.
4709 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4710 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4711 max_buffer_offset *= unit_size; // convert to bytes
4712 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004713
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004714 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004715 skip |=
4716 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4717 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004718 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004719 }
4720 }
4721
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004722 return skip;
4723}
4724
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004725bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4726 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004727 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004728 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004729 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004730
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004731 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004732
4733 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004734 skip |= ValidateCmd(cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004735
4736 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004737 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004738
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004739 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004740
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004741 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4742 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 -06004743 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004744 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004745 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004746 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004747 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004748 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004749 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004750 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004751
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004752 skip |= ValidateImageSampleCount(src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004753 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004754 skip |= ValidateMemoryIsBoundToImage(src_image_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4755 skip |=
4756 ValidateMemoryIsBoundToBuffer(dst_buffer_state, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004757
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004758 // Validate that SRC image & DST buffer have correct usage flags set
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004759 skip |= ValidateImageUsageFlags(src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004760 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4761 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004762 skip |= ValidateBufferUsageFlags(dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004763 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4764 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004765 if (GetApiVersion() >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004766 skip |= ValidateImageFormatFeatureFlags(src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImageToBuffer()",
4767 "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004768 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004769 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004770 skip |= InsideRenderPass(cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004771 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004772 const char *src_invalid_layout_vuid = (src_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4773 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4774 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004775 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004776 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
Cort Strattond619a302018-05-17 19:46:32 -07004777 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004778 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004779 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4780 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004781 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4782 cb_node, src_image_state, &pRegions[i], i, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
4783 skip |=
4784 ValidateImageMipLevel(cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyImageToBuffer()",
4785 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4786 skip |= ValidateImageArrayLayerRange(cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004787 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4788 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004789 }
4790 return skip;
4791}
4792
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004793void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4794 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004795 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004796 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004797 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004798
John Zulauff660ad62019-03-23 07:16:05 -06004799 // Make sure that all image slices record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004800 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004801 SetImageInitialLayout(cb_node, *src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004802 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004803 // Update bindings between buffer/image and cmd buffer
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004804 AddCommandBufferBindingImage(cb_node, src_image_state);
4805 AddCommandBufferBindingBuffer(cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004806}
4807
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004808bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4809 VkImageLayout dstImageLayout, uint32_t regionCount,
4810 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004811 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004812 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004813 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004814
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004815 bool skip = ValidateBufferImageCopyData(regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004816
4817 // Validate command buffer state
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004818 skip |= ValidateCmd(cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004819
4820 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004821 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004822 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004823 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4824 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 -06004825 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004826 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004827 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004828 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004829 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004830 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004831 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004832 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004833 skip |= ValidateImageSampleCount(dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004834 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
Mark Lobodzinski0ebe9712019-03-07 13:39:07 -07004835 skip |=
4836 ValidateMemoryIsBoundToBuffer(src_buffer_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4837 skip |= ValidateMemoryIsBoundToImage(dst_image_state, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004838 skip |= ValidateBufferUsageFlags(src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004839 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4840 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004841 skip |= ValidateImageUsageFlags(dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004842 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4843 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004844 if (GetApiVersion() >= VK_API_VERSION_1_1 || device_extensions.vk_khr_maintenance1) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004845 skip |= ValidateImageFormatFeatureFlags(dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyBufferToImage()",
4846 "VUID-vkCmdCopyBufferToImage-dstImage-01997",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004847 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004848 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004849 skip |= InsideRenderPass(cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004850 bool hit_error = false;
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004851 const char *dst_invalid_layout_vuid = (dst_image_state->shared_presentable && device_extensions.vk_khr_shared_presentable_image)
4852 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4853 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004854 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004855 skip |= ValidateImageSubresourceLayers(cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
Cort Strattond619a302018-05-17 19:46:32 -07004856 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004857 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004858 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4859 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinskifbeb0ca2019-03-09 11:48:22 -07004860 skip |= ValidateCopyBufferImageTransferGranularityRequirements(
4861 cb_node, dst_image_state, &pRegions[i], i, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
4862 skip |=
4863 ValidateImageMipLevel(cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i, "vkCmdCopyBufferToImage()",
4864 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4865 skip |= ValidateImageArrayLayerRange(cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
Cort Strattonff1542a2018-05-27 10:49:28 -07004866 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4867 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004868 }
4869 return skip;
4870}
4871
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004872void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4873 VkImageLayout dstImageLayout, uint32_t regionCount,
4874 const VkBufferImageCopy *pRegions) {
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004875 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004876 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004877 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004878
John Zulauff660ad62019-03-23 07:16:05 -06004879 // Make sure that all image slices are record referenced layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004880 for (uint32_t i = 0; i < regionCount; ++i) {
John Zulauff660ad62019-03-23 07:16:05 -06004881 SetImageInitialLayout(cb_node, *dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004882 }
Mark Lobodzinskifae179e2019-03-08 16:47:08 -07004883 AddCommandBufferBindingBuffer(cb_node, src_buffer_state);
4884 AddCommandBufferBindingImage(cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004885}
Mike Weiblen672b58b2017-02-21 14:32:53 -07004886
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004887bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
4888 VkSubresourceLayout *pLayout) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004889 bool skip = false;
4890 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
4891
Dave Houlton1d960ff2018-01-19 12:17:05 -07004892 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07004893 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
4894 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
4895 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004896 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 -06004897 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004898 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004899 }
4900
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004901 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004902 if (!image_entry) {
4903 return skip;
4904 }
4905
Dave Houlton1d960ff2018-01-19 12:17:05 -07004906 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07004907 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004908 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4909 "VUID-vkGetImageSubresourceLayout-image-00996",
4910 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004911 }
4912
Dave Houlton1d960ff2018-01-19 12:17:05 -07004913 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004914 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004915 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4916 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
4917 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
4918 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004919 }
4920
Dave Houlton1d960ff2018-01-19 12:17:05 -07004921 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07004922 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06004923 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
4924 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
4925 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
4926 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07004927 }
4928
Dave Houlton1d960ff2018-01-19 12:17:05 -07004929 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07004930 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07004931 if (FormatIsMultiplane(img_format)) {
4932 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004933 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004934 if (FormatPlaneCount(img_format) > 2u) {
4935 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06004936 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07004937 }
4938 if (sub_aspect != (sub_aspect & allowed_flags)) {
4939 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 -06004940 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07004941 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004942 ") must be a single-plane specifier flag.",
4943 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07004944 }
4945 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004946 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07004947 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004948 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06004949 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004950 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004951 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004952 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07004953 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06004954 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 -06004955 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07004956 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004957 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07004958 }
4959 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004960
Mark Lobodzinskif45e45f2019-04-19 14:15:39 -06004961 if (device_extensions.vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskie9b99792019-03-07 16:34:29 -07004962 skip |= ValidateGetImageSubresourceLayoutANDROID(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004963 }
4964
Mike Weiblen672b58b2017-02-21 14:32:53 -07004965 return skip;
4966}