blob: f9ef69d0ad5bae2ba51262c6f47ab366712053f6 [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
Dave Houltond9611312018-11-19 17:03:36 -070043uint32_t FullMipChainLevels(uint32_t height, uint32_t width, uint32_t depth) {
44 // uint cast applies floor()
45 return 1u + (uint32_t)log2(std::max({height, width, depth}));
46}
47
48uint32_t FullMipChainLevels(VkExtent3D extent) { return FullMipChainLevels(extent.height, extent.width, extent.depth); }
49
50uint32_t FullMipChainLevels(VkExtent2D extent) { return FullMipChainLevels(extent.height, extent.width); }
51
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070052void CoreChecks::SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair,
53 const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070054 auto it = pCB->imageLayoutMap.find(imgpair);
55 if (it != pCB->imageLayoutMap.end()) {
56 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070057 } else {
58 assert(imgpair.hasSubresource);
59 IMAGE_CMD_BUF_LAYOUT_NODE node;
60 if (!FindCmdBufLayout(device_data, pCB, imgpair.image, imgpair.subresource, node)) {
61 node.initialLayout = layout;
62 }
63 SetLayout(device_data, pCB, imgpair, {node.initialLayout, layout});
64 }
65}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070066
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070067template <class OBJECT, class LAYOUT>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070068void CoreChecks::SetLayout(layer_data *device_data, OBJECT *pObject, VkImage image, VkImageSubresource range,
69 const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070070 ImageSubresourcePair imgpair = {image, true, range};
71 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
72 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
73 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
74 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -070075 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070076 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
77 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
78 SetLayout(device_data, pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
79 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070080}
81
82template <class OBJECT, class LAYOUT>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070083void CoreChecks::SetLayout(layer_data *device_data, OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout,
84 VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070085 if (imgpair.subresource.aspectMask & aspectMask) {
86 imgpair.subresource.aspectMask = aspectMask;
87 SetLayout(device_data, pObject, imgpair, layout);
88 }
89}
90
Tony Barbourdf013b92017-01-25 12:53:48 -070091// Set the layout in supplied map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070092void CoreChecks::SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
93 ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070094 auto it = imageLayoutMap.find(imgpair);
95 if (it != imageLayoutMap.end()) {
96 it->second.layout = layout; // Update
97 } else {
98 imageLayoutMap[imgpair].layout = layout; // Insert
99 }
Tony Barbourdf013b92017-01-25 12:53:48 -0700100}
101
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700102bool CoreChecks::FindLayoutVerifyNode(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair,
103 IMAGE_CMD_BUF_LAYOUT_NODE &node, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700104 if (!(imgpair.subresource.aspectMask & aspectMask)) {
105 return false;
106 }
107 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
108 imgpair.subresource.aspectMask = aspectMask;
109 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
110 if (imgsubIt == pCB->imageLayoutMap.end()) {
111 return false;
112 }
113 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200114 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 -0600115 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700116 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
117 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700118 string_VkImageLayout(imgsubIt->second.layout));
119 }
120 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200121 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 -0600122 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700123 "Cannot query for VkImage %s"
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700124 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700125 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700126 string_VkImageLayout(imgsubIt->second.initialLayout));
127 }
128 node = imgsubIt->second;
129 return true;
130}
131
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700132bool CoreChecks::FindLayoutVerifyLayout(layer_data const *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout,
133 const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700134 if (!(imgpair.subresource.aspectMask & aspectMask)) {
135 return false;
136 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700137 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
138 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700139 auto imgsubIt = (*GetImageLayoutMap(device_data)).find(imgpair);
140 if (imgsubIt == (*GetImageLayoutMap(device_data)).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700141 return false;
142 }
143 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200144 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 -0600145 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700146 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
147 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700148 string_VkImageLayout(imgsubIt->second.layout));
149 }
150 layout = imgsubIt->second.layout;
151 return true;
152}
153
154// Find layout(s) on the command buffer level
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700155bool CoreChecks::FindCmdBufLayout(layer_data const *device_data, GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
156 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700157 ImageSubresourcePair imgpair = {image, true, range};
158 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
159 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
160 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
161 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
162 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700163 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700164 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
165 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
166 FindLayoutVerifyNode(device_data, pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
167 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700168 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
169 imgpair = {image, false, VkImageSubresource()};
170 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
171 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
172 // TODO: This is ostensibly a find function but it changes state here
173 node = imgsubIt->second;
174 }
175 return true;
176}
177
178// Find layout(s) on the global level
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700179bool CoreChecks::FindGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700180 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
181 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
182 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
183 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
184 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700185 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700186 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
187 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
188 FindLayoutVerifyLayout(device_data, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
189 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700190 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
191 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700192 auto imgsubIt = (*GetImageLayoutMap(device_data)).find(imgpair);
193 if (imgsubIt == (*GetImageLayoutMap(device_data)).end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700194 layout = imgsubIt->second.layout;
195 }
196 return true;
197}
198
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700199bool CoreChecks::FindLayouts(layer_data *device_data, VkImage image, std::vector<VkImageLayout> &layouts) {
200 auto sub_data = (*GetImageSubresourceMap(device_data)).find(image);
201 if (sub_data == (*GetImageSubresourceMap(device_data)).end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700202 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700203 if (!image_state) return false;
204 bool ignoreGlobal = false;
205 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
206 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
207 ignoreGlobal = true;
208 }
209 for (auto imgsubpair : sub_data->second) {
210 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700211 auto img_data = (*GetImageLayoutMap(device_data)).find(imgsubpair);
212 if (img_data != (*GetImageLayoutMap(device_data)).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700213 layouts.push_back(img_data->second.layout);
214 }
215 }
216 return true;
217}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700218
219bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
220 ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700221 if (!(imgpair.subresource.aspectMask & aspectMask)) {
222 return false;
223 }
224 imgpair.subresource.aspectMask = aspectMask;
225 auto imgsubIt = imageLayoutMap.find(imgpair);
226 if (imgsubIt == imageLayoutMap.end()) {
227 return false;
228 }
229 layout = imgsubIt->second.layout;
230 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700231}
Tony Barbourdf013b92017-01-25 12:53:48 -0700232
233// find layout in supplied map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700234bool CoreChecks::FindLayout(layer_data *device_data,
235 const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
236 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700237 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
238 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
239 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
240 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
241 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700242 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700243 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
244 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
245 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
246 }
247 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700248 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
249 imgpair = {imgpair.image, false, VkImageSubresource()};
250 auto imgsubIt = imageLayoutMap.find(imgpair);
251 if (imgsubIt == imageLayoutMap.end()) return false;
252 layout = imgsubIt->second.layout;
253 }
254 return true;
255}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700256
257// Set the layout on the global level
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700258void CoreChecks::SetGlobalLayout(layer_data *device_data, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700259 VkImage &image = imgpair.image;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700260 auto &lmap = (*GetImageLayoutMap(device_data));
Dave Houltonb3f4b282018-02-22 16:25:16 -0700261 auto data = lmap.find(imgpair);
262 if (data != lmap.end()) {
263 data->second.layout = layout; // Update
264 } else {
265 lmap[imgpair].layout = layout; // Insert
266 }
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700267 auto &image_subresources = (*GetImageSubresourceMap(device_data))[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700268 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
269 if (subresource == image_subresources.end()) {
270 image_subresources.push_back(imgpair);
271 }
272}
273
274// Set the layout on the cmdbuf level
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700275void CoreChecks::SetLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair,
276 const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700277 auto it = pCB->imageLayoutMap.find(imgpair);
278 if (it != pCB->imageLayoutMap.end()) {
279 it->second = node; // Update
280 } else {
281 pCB->imageLayoutMap[imgpair] = node; // Insert
282 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700283}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600284// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700285void CoreChecks::SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
286 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600287 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700288 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600289 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
290 uint32_t level = image_subresource_range.baseMipLevel + level_index;
291 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
292 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
293 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700294 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
295 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600296 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600297 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700298 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
299 }
300 }
Tony-LunarG119b38a2018-12-18 09:49:16 -0700301 // For multiplane images, IMAGE_ASPECT_COLOR is an alias for all of the plane bits
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700302 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG119b38a2018-12-18 09:49:16 -0700303 if (FormatIsMultiplane(image_state->createInfo.format)) {
304 if (sub.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
305 sub.aspectMask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
306 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR;
307 if (FormatPlaneCount(image_state->createInfo.format) > 2) {
308 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
309 }
310 }
311 }
312 }
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600313 SetLayout(device_data, cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700314 }
315 }
316}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600317// Set image layout for given VkImageSubresourceLayers struct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700318void CoreChecks::SetImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
319 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600320 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
321 VkImageSubresourceRange image_subresource_range;
322 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
323 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
324 image_subresource_range.layerCount = image_subresource_layers.layerCount;
325 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
326 image_subresource_range.levelCount = 1;
327 SetImageLayout(device_data, cb_node, image_state, image_subresource_range, layout);
328}
Dave Houltonddd65c52018-05-08 14:58:01 -0600329
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600330// Set image layout for all slices of an image view
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700331void CoreChecks::SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state,
332 const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600333 assert(view_state);
334
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700335 IMAGE_STATE *image_state = GetImageState(view_state->create_info.image);
Dave Houltonddd65c52018-05-08 14:58:01 -0600336 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
337
338 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
339 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
340 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
341 sub_range.baseArrayLayer = 0;
342 sub_range.layerCount = image_state->createInfo.extent.depth;
343 }
344
345 SetImageLayout(device_data, cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600346}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700347
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700348void CoreChecks::SetImageViewLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImageView imageView,
349 const VkImageLayout &layout) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700350 auto view_state = GetImageViewState(imageView);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600351 SetImageViewLayout(device_data, cb_node, view_state, layout);
352}
353
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700354bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(layer_data *device_data, RenderPassCreateVersion rp_version,
355 VkImageLayout layout, VkImage image, VkImageView image_view,
356 VkFramebuffer framebuffer, VkRenderPass renderpass,
357 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100358 bool skip = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700359 const auto report_data = GetReportData(device_data);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700360 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100361 const char *vuid;
362 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
363
364 if (!image_state) {
365 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
366 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700367 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
368 "] = image view %s, which refers to an invalid image",
369 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
370 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100371 return skip;
372 }
373
374 auto image_usage = image_state->createInfo.usage;
375
376 // Check for layouts that mismatch image usages in the framebuffer
377 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
378 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
379 skip |=
380 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700381 "Layout/usage mismatch for attachment %u in render pass %s"
382 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100383 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700384 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
385 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 }
387
388 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
389 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
390 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
391 skip |=
392 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700393 "Layout/usage mismatch for attachment %u in render pass %s"
394 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100395 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700396 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
397 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100398 }
399
400 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
401 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
402 skip |=
403 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700404 "Layout/usage mismatch for attachment %u in render pass %s"
405 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100406 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700407 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
408 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100409 }
410
411 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
412 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
413 skip |=
414 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700415 "Layout/usage mismatch for attachment %u in render pass %s"
416 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100417 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700418 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
419 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100420 }
421
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700422 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100423 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
424 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
425 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
426 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
427 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
428 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700429 skip |= log_msg(
430 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
431 "Layout/usage mismatch for attachment %u in render pass %s"
432 " - the %s is %s but the image attached to framebuffer %s via image view %s"
433 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
434 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
435 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100436 }
437 } else {
438 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
439 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
440 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
441 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
442 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
443 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700444 "Layout/usage mismatch for attachment %u in render pass %s"
445 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100446 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700447 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name,
448 string_VkImageLayout(layout), report_data->FormatHandle(renderpass).c_str(),
449 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100450 }
451 }
452 return skip;
453}
454
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700455bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(layer_data *device_data, RenderPassCreateVersion rp_version,
456 GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
457 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600458 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700459 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100461
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700462 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100463 auto framebuffer = framebuffer_state->framebuffer;
464
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700465 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600466 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -0600467 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700468 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700469 }
470 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
471 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700472 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600473
474 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700475 skip |=
476 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
477 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
478 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
479 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
480 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600481 continue;
482 }
483
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700484 const VkImage &image = view_state->create_info.image;
485 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700486 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100487 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
488
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700489 // TODO: Do not iterate over every possibility - consolidate where possible
490 for (uint32_t j = 0; j < subRange.levelCount; j++) {
491 uint32_t level = subRange.baseMipLevel + j;
492 for (uint32_t k = 0; k < subRange.layerCount; k++) {
493 uint32_t layer = subRange.baseArrayLayer + k;
494 VkImageSubresource sub = {subRange.aspectMask, level, layer};
495 IMAGE_CMD_BUF_LAYOUT_NODE node;
496 if (!FindCmdBufLayout(device_data, pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700497 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700498 continue;
499 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700500 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600501 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 -0600502 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700503 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
504 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
505 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600506 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700507 }
508 }
509 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100510
511 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, initial_layout, image, image_view,
512 framebuffer, render_pass, i, "initial layout");
513
514 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, final_layout, image, image_view, framebuffer,
515 render_pass, i, "final layout");
516 }
517
518 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
519 auto &subpass = pRenderPassInfo->pSubpasses[j];
520 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
521 auto &attachment_ref = subpass.pInputAttachments[k];
522 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
523 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700524 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100525
526 if (view_state) {
527 auto image = view_state->create_info.image;
528 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
529 image_view, framebuffer, render_pass,
530 attachment_ref.attachment, "input attachment layout");
531 }
532 }
533 }
534
535 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
536 auto &attachment_ref = subpass.pColorAttachments[k];
537 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
538 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700539 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100540
541 if (view_state) {
542 auto image = view_state->create_info.image;
543 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
544 image_view, framebuffer, render_pass,
545 attachment_ref.attachment, "color attachment layout");
546 if (subpass.pResolveAttachments) {
547 ValidateRenderPassLayoutAgainstFramebufferImageUsage(
548 device_data, rp_version, attachment_ref.layout, image, image_view, framebuffer, render_pass,
549 attachment_ref.attachment, "resolve attachment layout");
550 }
551 }
552 }
553 }
554
555 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
556 auto &attachment_ref = *subpass.pDepthStencilAttachment;
557 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
558 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700559 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100560
561 if (view_state) {
562 auto image = view_state->create_info.image;
563 ValidateRenderPassLayoutAgainstFramebufferImageUsage(device_data, rp_version, attachment_ref.layout, image,
564 image_view, framebuffer, render_pass,
565 attachment_ref.attachment, "input attachment layout");
566 }
567 }
568 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700569 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600570 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700571}
572
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700573void CoreChecks::TransitionAttachmentRefLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
574 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700575 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700576 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600577 if (image_view) {
578 SetImageViewLayout(device_data, pCB, image_view, ref.layout);
579 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700580 }
581}
582
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700583void CoreChecks::TransitionSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state,
584 const int subpass_index, FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700585 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700586
587 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700588 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700589 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
590 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pInputAttachments[j]);
591 }
592 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
593 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, subpass.pColorAttachments[j]);
594 }
595 if (subpass.pDepthStencilAttachment) {
596 TransitionAttachmentRefLayout(device_data, pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
597 }
598 }
599}
600
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700601bool CoreChecks::ValidateImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE const *pCB,
602 const VkImageMemoryBarrier *mem_barrier, uint32_t level, uint32_t layer,
603 VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700604 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
605 return false;
606 }
607 VkImageSubresource sub = {aspect, level, layer};
608 IMAGE_CMD_BUF_LAYOUT_NODE node;
609 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700610 return false;
611 }
612 bool skip = false;
613 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
614 // TODO: Set memory invalid which is in mem_tracker currently
615 } else if (node.layout != mem_barrier->oldLayout) {
Lockee9aeebf2019-03-03 23:50:08 -0700616 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700617 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
618 HandleToUint64(pCB->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700619 "For image %s you cannot transition the layout of aspect=%d level=%d layer=%d from %s when current layout is %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700620 report_data->FormatHandle(mem_barrier->image).c_str(), aspect, level, layer,
Lockee9aeebf2019-03-03 23:50:08 -0700621 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700622 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700623 return skip;
624}
625
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700626// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
627// 1. Transition into initialLayout state
628// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700629void CoreChecks::TransitionBeginRenderPassLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
630 const RENDER_PASS_STATE *render_pass_state,
631 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700632 // First transition into initialLayout
633 auto const rpci = render_pass_state->createInfo.ptr();
634 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700635 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600636 if (view_state) {
637 SetImageViewLayout(device_data, cb_state, view_state, rpci->pAttachments[i].initialLayout);
638 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700639 }
640 // Now transition for first subpass (index 0)
641 TransitionSubpassLayouts(device_data, cb_state, render_pass_state, 0, framebuffer_state);
642}
643
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700644void CoreChecks::TransitionImageAspectLayout(layer_data *device_data, GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier,
645 uint32_t level, uint32_t layer, VkImageAspectFlags aspect_mask,
646 VkImageAspectFlags aspect) {
Tony-LunarG0d27b302018-10-08 09:26:21 -0600647 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700648 return;
649 }
650 VkImageSubresource sub = {aspect, level, layer};
651 IMAGE_CMD_BUF_LAYOUT_NODE node;
652 if (!FindCmdBufLayout(device_data, pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700653 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700654 SetLayout(device_data, pCB, mem_barrier->image, sub,
655 IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
656 return;
657 }
658 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
659 // TODO: Set memory invalid
660 }
661 SetLayout(device_data, pCB, mem_barrier->image, sub, mem_barrier->newLayout);
662}
663
Dave Houlton10b39482017-03-16 13:18:15 -0600664bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600665 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600666 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600667 }
668 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600669 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600670 }
671 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600672 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600673 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700674 if (0 !=
675 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
676 if (FormatPlaneCount(format) == 1) return false;
677 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600678 return true;
679}
680
Mike Weiblen62d08a32017-03-07 22:18:27 -0700681// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700682bool CoreChecks::ValidateBarrierLayoutToImageUsage(layer_data *device_data, const VkImageMemoryBarrier *img_barrier,
683 bool new_not_old, VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 bool skip = false;
685 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600686 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700687
688 switch (layout) {
689 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
690 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600691 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700692 }
693 break;
694 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
695 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600696 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700697 }
698 break;
699 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
700 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600701 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700702 }
703 break;
704 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
705 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600706 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700707 }
708 break;
709 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
710 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600711 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700712 }
713 break;
714 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
715 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600716 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700717 }
718 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600719 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500720 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
721 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
722 }
723 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700724 default:
725 // Other VkImageLayout values do not have VUs defined in this context.
726 break;
727 }
728
Dave Houlton8e9f6542018-05-18 12:18:22 -0600729 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600730 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 -0600731 HandleToUint64(img_barrier->image), msg_code,
Lockee9aeebf2019-03-03 23:50:08 -0700732 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image %s usage flags 0x%" PRIx32 ".", func_name,
733 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
734 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700735 }
736 return skip;
737}
738
John Zulauf463c51e2018-05-31 13:29:20 -0600739// Scoreboard for checking for duplicate and inconsistent barriers to images
740struct ImageBarrierScoreboardEntry {
741 uint32_t index;
742 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
743 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
744 const VkImageMemoryBarrier *barrier;
745};
746using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
747using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
748
Mike Weiblen62d08a32017-03-07 22:18:27 -0700749// Verify image barriers are compatible with the images they reference.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700750bool CoreChecks::ValidateBarriersToImages(layer_data *device_data, GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
751 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700752 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700753
John Zulauf463c51e2018-05-31 13:29:20 -0600754 // Scoreboard for duplicate layout transition barriers within the list
755 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
756 ImageBarrierScoreboardImageMap layout_transitions;
757
Mike Weiblen62d08a32017-03-07 22:18:27 -0700758 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
759 auto img_barrier = &pImageMemoryBarriers[i];
760 if (!img_barrier) continue;
761
John Zulauf463c51e2018-05-31 13:29:20 -0600762 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
763 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
764 // at a per sub-resource level
765 if (img_barrier->oldLayout != img_barrier->newLayout) {
766 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
767 auto image_it = layout_transitions.find(img_barrier->image);
768 if (image_it != layout_transitions.end()) {
769 auto &subres_map = image_it->second;
770 auto subres_it = subres_map.find(img_barrier->subresourceRange);
771 if (subres_it != subres_map.end()) {
772 auto &entry = subres_it->second;
773 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
774 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
775 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
776 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700777 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
778 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700779 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600780 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
781 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700782 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700783 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
784 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600785 }
786 entry = new_entry;
787 } else {
788 subres_map[img_barrier->subresourceRange] = new_entry;
789 }
790 } else {
791 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
792 }
793 }
794
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700795 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600796 if (image_state) {
797 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
798 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, false, usage_flags, func_name);
799 skip |= ValidateBarrierLayoutToImageUsage(device_data, img_barrier, true, usage_flags, func_name);
800
801 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
802 if (image_state->layout_locked) {
803 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600804 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700805 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
806 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700807 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600808 " 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 -0700809 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
810 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600811 }
812 }
813
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700814 VkImageCreateInfo *image_create_info = &(GetImageState(img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600815 // For a Depth/Stencil image both aspects MUST be set
816 if (FormatIsDepthAndStencil(image_create_info->format)) {
817 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
818 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
819 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700820 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
821 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
Lockee9aeebf2019-03-03 23:50:08 -0700822 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
823 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
824 func_name, static_cast<const void *>(img_barrier),
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700825 report_data->FormatHandle(img_barrier->image).c_str(), string_VkFormat(image_create_info->format),
826 aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600827 }
828 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600829 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
830 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700831
Mike Weiblen62d08a32017-03-07 22:18:27 -0700832 for (uint32_t j = 0; j < level_count; j++) {
833 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
834 for (uint32_t k = 0; k < layer_count; k++) {
835 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Tobin Ehlis9c0df962017-07-17 10:14:27 -0600836 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
837 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
838 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
839 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700840 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700841 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
842 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
843 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
844 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
845 skip |= ValidateImageAspectLayout(device_data, cb_state, img_barrier, level, layer,
846 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
847 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700848 }
849 }
850 }
851 return skip;
852}
853
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700854bool CoreChecks::IsReleaseOp(layer_data *device_data, GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600855 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700856
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700857 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700858 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700859}
860
John Zulauf6b4aae82018-05-09 13:03:36 -0600861template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700862bool CoreChecks::ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
863 uint32_t barrier_count, const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600864 using BarrierRecord = QFOTransferBarrier<Barrier>;
865 bool skip = false;
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700866 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600867 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
868 const char *barrier_name = BarrierRecord::BarrierName();
869 const char *handle_name = BarrierRecord::HandleName();
870 const char *transfer_type = nullptr;
871 for (uint32_t b = 0; b < barrier_count; b++) {
872 if (!IsTransferOp(&barriers[b])) continue;
873 const BarrierRecord *barrier_record = nullptr;
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 const auto found = barrier_sets.release.find(barriers[b]);
877 if (found != barrier_sets.release.cend()) {
878 barrier_record = &(*found);
879 transfer_type = "releasing";
880 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600881 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
882 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600883 const auto found = barrier_sets.acquire.find(barriers[b]);
884 if (found != barrier_sets.acquire.cend()) {
885 barrier_record = &(*found);
886 transfer_type = "acquiring";
887 }
888 }
889 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700890 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
891 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
892 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
893 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
894 func_name, barrier_name, b, transfer_type, handle_name,
895 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
896 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600897 }
898 }
899 return skip;
900}
901
902template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700903void CoreChecks::RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
904 const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700905 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600906 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
907 for (uint32_t b = 0; b < barrier_count; b++) {
908 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700909 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
910 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600911 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600912 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
913 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600914 barrier_sets.acquire.emplace(barriers[b]);
915 }
916 }
917}
918
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700919bool CoreChecks::ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
920 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
921 uint32_t imageMemBarrierCount,
922 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600923 bool skip = false;
924 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
925 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
926 return skip;
927}
928
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700929void CoreChecks::RecordBarriersQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
930 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
931 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600932 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
933 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
934}
935
936template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700937bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
938 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600939 // Record to the scoreboard or report that we have a duplication
940 bool skip = false;
941 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
942 if (!inserted.second && inserted.first->second != cb_state) {
943 // 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 -0700944 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
945 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
946 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
947 " duplicates existing barrier submitted in this batch from command buffer %s.",
948 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
949 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
950 report_data->FormatHandle(inserted.first->second).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600951 }
952 return skip;
953}
954
955template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700956bool CoreChecks::ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
957 QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600958 using BarrierRecord = QFOTransferBarrier<Barrier>;
959 using TypeTag = typename BarrierRecord::Tag;
960 bool skip = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700961 const auto report_data = device_data->GetReportData(device_data);
John Zulauf6b4aae82018-05-09 13:03:36 -0600962 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700963 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600964 const char *barrier_name = BarrierRecord::BarrierName();
965 const char *handle_name = BarrierRecord::HandleName();
966 // No release should have an extant duplicate (WARNING)
967 for (const auto &release : cb_barriers.release) {
968 // Check the global pending release barriers
969 const auto set_it = global_release_barriers.find(release.handle);
970 if (set_it != global_release_barriers.cend()) {
971 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
972 const auto found = set_for_handle.find(release);
973 if (found != set_for_handle.cend()) {
974 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
975 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700976 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600977 " to dstQueueFamilyIndex %" PRIu32
978 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700979 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600980 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
981 }
982 }
983 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
984 }
985 // Each acquire must have a matching release (ERROR)
986 for (const auto &acquire : cb_barriers.acquire) {
987 const auto set_it = global_release_barriers.find(acquire.handle);
988 bool matching_release_found = false;
989 if (set_it != global_release_barriers.cend()) {
990 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
991 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
992 }
993 if (!matching_release_found) {
994 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
995 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700996 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
997 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
998 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600999 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
1000 }
1001 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
1002 }
1003 return skip;
1004}
1005
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001006bool CoreChecks::ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
1007 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
1008 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001009 bool skip = false;
1010 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
1011 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
1012 return skip;
1013}
1014
1015template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001016void CoreChecks::RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001017 using BarrierRecord = QFOTransferBarrier<Barrier>;
1018 using TypeTag = typename BarrierRecord::Tag;
1019 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001020 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(device_data, TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001021
1022 // Add release barriers from this submit to the global map
1023 for (const auto &release : cb_barriers.release) {
1024 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1025 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1026 global_release_barriers[release.handle].insert(release);
1027 }
1028
1029 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1030 for (const auto &acquire : cb_barriers.acquire) {
1031 // NOTE: We're not using [] because we don't want to create entries for missing releases
1032 auto set_it = global_release_barriers.find(acquire.handle);
1033 if (set_it != global_release_barriers.end()) {
1034 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1035 set_for_handle.erase(acquire);
1036 if (set_for_handle.size() == 0) { // Clean up empty sets
1037 global_release_barriers.erase(set_it);
1038 }
1039 }
1040 }
1041}
1042
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001043void CoreChecks::RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001044 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1045 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1046}
1047
John Zulauf6b4aae82018-05-09 13:03:36 -06001048// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001049void CoreChecks::EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001050 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1051}
1052
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001053void CoreChecks::TransitionImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
1054 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001055 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1056 auto mem_barrier = &pImgMemBarriers[i];
1057 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001058
Chris Forbes4de4b132017-08-21 11:27:08 -07001059 // For ownership transfers, the barrier is specified twice; as a release
1060 // operation on the yielding queue family, and as an acquire operation
1061 // on the acquiring queue family. This barrier may also include a layout
1062 // transition, which occurs 'between' the two operations. For validation
1063 // purposes it doesn't seem important which side performs the layout
1064 // transition, but it must not be performed twice. We'll arbitrarily
1065 // choose to perform it as part of the acquire operation.
1066 if (IsReleaseOp(device_data, cb_state, mem_barrier)) {
1067 continue;
1068 }
1069
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001070 VkImageCreateInfo *image_create_info = &(GetImageState(mem_barrier->image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001071 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1072 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1073
Dave Houltonb3f4b282018-02-22 16:25:16 -07001074 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1075 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1076 // for all (potential) layer sub_resources.
1077 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1078 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1079 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1080 }
1081
Tony-LunarG0d27b302018-10-08 09:26:21 -06001082 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1083 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001084 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001085 if (FormatIsMultiplane(image_create_info->format)) {
1086 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1087 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1088 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1089 if (FormatPlaneCount(image_create_info->format) > 2) {
1090 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1091 }
1092 }
1093 }
1094 }
1095
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001096 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001097 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001098 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001099 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Tony-LunarG0d27b302018-10-08 09:26:21 -06001100 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1101 VK_IMAGE_ASPECT_COLOR_BIT);
1102 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1103 VK_IMAGE_ASPECT_DEPTH_BIT);
1104 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1105 VK_IMAGE_ASPECT_STENCIL_BIT);
1106 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1107 VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001108 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001109 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1110 VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1111 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1112 VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1113 TransitionImageAspectLayout(device_data, cb_state, mem_barrier, level, layer, aspect_mask,
1114 VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001115 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001116 }
1117 }
1118 }
1119}
1120
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001121bool CoreChecks::VerifyImageLayout(layer_data const *device_data, GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state,
1122 VkImageSubresourceLayers subLayers, VkImageLayout explicit_layout, VkImageLayout optimal_layout,
1123 const char *caller, const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code,
1124 bool *error) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001125 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001126 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001127
1128 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1129 uint32_t layer = i + subLayers.baseArrayLayer;
1130 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1131 IMAGE_CMD_BUF_LAYOUT_NODE node;
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001132 if (FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1133 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001134 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001135 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1136 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001137 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the actual "
1138 "current layout %s.",
1139 caller, report_data->FormatHandle(image).c_str(), layer, subLayers.mipLevel,
1140 string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001141 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001142 }
1143 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001144 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1145 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1146 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001147 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1148 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001149 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001150 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001151 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001152 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1153 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001154 }
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001155 } else if (GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001156 if (image_state->shared_presentable) {
1157 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001158 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1159 layout_invalid_msg_code,
1160 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1161 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001162 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001163 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001164 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001165 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001166 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 -07001167 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001168 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1169 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1170 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001171 }
1172 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001173 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001174}
1175
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001176void CoreChecks::TransitionFinalSubpassLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
1177 const VkRenderPassBeginInfo *pRenderPassBegin,
1178 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001179 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001180 if (!renderPass) return;
1181
Tobias Hectorbbb12282018-10-22 15:17:59 +01001182 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001183 if (framebuffer_state) {
1184 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001185 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001186 if (view_state) {
1187 SetImageViewLayout(device_data, pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
1188 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001189 }
1190 }
1191}
Dave Houltone19e20d2018-02-02 16:32:41 -07001192
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001193#ifdef VK_USE_PLATFORM_ANDROID_KHR
1194// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1195// This could also move into a seperate core_validation_android.cpp file... ?
1196
1197//
1198// AHB-specific validation within non-AHB APIs
1199//
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001200bool CoreChecks::ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1201 const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001202 bool skip = false;
1203
1204 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1205 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001206 if (0 != ext_fmt_android->externalFormat) {
1207 if (VK_FORMAT_UNDEFINED != create_info->format) {
1208 skip |=
1209 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1210 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001211 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001212 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1213 }
1214
1215 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1216 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1217 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001218 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001219 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1220 }
1221
1222 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1223 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1224 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001225 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001226 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1227 }
1228
1229 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1230 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1231 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001232 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001233 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1234 }
1235 }
1236
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001237 auto ahb_formats = GetAHBExternalFormatsSet(device_data);
1238 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1239 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1240 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001241 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001242 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1243 }
1244 }
1245
Dave Houltond9611312018-11-19 17:03:36 -07001246 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001247 if (VK_FORMAT_UNDEFINED == create_info->format) {
1248 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1249 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001250 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001251 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1252 }
1253 }
1254
1255 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1256 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1257 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001258 skip |=
1259 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1260 "VUID-VkImageCreateInfo-pNext-02393",
1261 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1262 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1263 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001264 }
1265
1266 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1267 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1268 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001269 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001270 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1271 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1272 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1273 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001274 }
1275
1276 return skip;
1277}
1278
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001279void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001280 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1281 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1282 is_node->imported_ahb = true;
1283 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001284 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001285 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001286 is_node->has_ahb_format = true;
1287 is_node->ahb_format = ext_fmt_android->externalFormat;
1288 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001289}
1290
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001291bool CoreChecks::ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001292 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001293 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001294
1295 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001296 if (VK_FORMAT_UNDEFINED != create_info->format) {
1297 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1298 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1299 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1300 "format member is %s.",
1301 string_VkFormat(create_info->format));
1302 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001303
Dave Houltond9611312018-11-19 17:03:36 -07001304 // Chain must include a compatible ycbcr conversion
1305 bool conv_found = false;
1306 uint64_t external_format = 0;
1307 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1308 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
1310 auto fmap = GetYcbcrConversionFormatMap(device_data);
Dave Houltond9611312018-11-19 17:03:36 -07001311 if (fmap->find(conv_handle) != fmap->end()) {
1312 conv_found = true;
1313 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001314 }
Dave Houltond9611312018-11-19 17:03:36 -07001315 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001316 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001317 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 -07001318 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1319 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1320 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1321 }
1322
1323 // Errors in create_info swizzles
1324 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1325 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1326 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1327 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1328 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1329 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1330 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1331 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001332 }
1333 }
Dave Houltond9611312018-11-19 17:03:36 -07001334
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001335 return skip;
1336}
1337
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001338bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001339 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001340
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001341 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001342 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1343 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1344 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001345 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001346 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1347 "bound to memory.");
1348 }
1349 return skip;
1350}
1351
1352#else
1353
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001354bool CoreChecks::ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1355 const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001356 return false;
1357}
1358
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001359void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001360
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001361bool CoreChecks::ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001362
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001363bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001364
1365#endif // VK_USE_PLATFORM_ANDROID_KHR
1366
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001367bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1368 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
1369 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001370 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001371
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001372 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001373 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1374 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1375 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1376 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1377 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001378 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001379 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001380 }
1381
Dave Houlton130c0212018-01-29 13:39:56 -07001382 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001383 skip |= log_msg(
1384 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1385 "VUID-VkImageCreateInfo-flags-00949",
1386 "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 -07001387 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001388
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001389 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001390 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1391 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1392 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001393 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 +00001394 "VUID-VkImageCreateInfo-usage-00964",
1395 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1396 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001397 }
1398
1399 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001400 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 +00001401 "VUID-VkImageCreateInfo-usage-00965",
1402 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1403 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001404 }
1405
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001406 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001407 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001408 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1409 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1410 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1411 string_VkFormat(pCreateInfo->format));
1412 } else {
1413 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1414 const char *format_string = string_VkFormat(pCreateInfo->format);
1415 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1416 "VUID-VkImageCreateInfo-mipLevels-02255",
1417 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1418 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1419 }
Dave Houlton130c0212018-01-29 13:39:56 -07001420
Dave Houltona585d132019-01-18 13:05:42 -07001421 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1422 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1423 (uint64_t)pCreateInfo->samples;
1424 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001425
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001426 // Round up to imageGranularity boundary
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001427 VkDeviceSize imageGranularity = GetPDProperties()->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001428 uint64_t ig_mask = imageGranularity - 1;
1429 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001430
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001431 if (total_size > format_limits.maxResourceSize) {
1432 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1433 kVUID_Core_Image_InvalidFormatLimitsViolation,
1434 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1435 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1436 total_size, format_limits.maxResourceSize);
1437 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001438
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001439 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1440 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1441 "VUID-VkImageCreateInfo-arrayLayers-02256",
1442 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1443 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1444 }
1445
1446 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1447 skip |=
1448 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1449 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001450 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001451 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001452 }
1453
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001454 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001455 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 -06001456 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001457 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1458 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001459 }
1460
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001461 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001462 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1463 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1464 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1465 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001466 skip |=
1467 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1468 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1469 "format must be block, ETC or ASTC compressed, but is %s",
1470 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001471 }
1472 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1473 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001474 skip |=
1475 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1476 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1477 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001478 }
1479 }
1480 }
1481
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001482 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001483 skip |=
1484 ValidateQueueFamilies(device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1485 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1486 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001487 }
1488
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001489 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001490}
1491
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001492void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1493 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
1494 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001495 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001496 IMAGE_LAYOUT_NODE image_state;
1497 image_state.layout = pCreateInfo->initialLayout;
1498 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001499 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001500 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001501 RecordCreateImageANDROID(pCreateInfo, is_node);
1502 }
1503 GetImageMap(device_data)->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001504 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001505 (*GetImageSubresourceMap(device_data))[*pImage].push_back(subpair);
1506 (*GetImageLayoutMap(device_data))[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001507}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001509bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001510 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001511 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001512 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001513 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001514 if (image_state) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001515 skip |= ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001516 }
1517 return skip;
1518}
1519
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001520void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001521 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001522 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001523 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001524 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001525 InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001526 // Clean up memory mapping, bindings and range references for image
1527 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001528 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001529 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001530 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001531 }
1532 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001533 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001534 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001535 // Remove image from imageMap
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001536 GetImageMap(device_data)->erase(image);
1537 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap = GetImageSubresourceMap(device_data);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001538
1539 const auto &sub_entry = imageSubresourceMap->find(image);
1540 if (sub_entry != imageSubresourceMap->end()) {
1541 for (const auto &pair : sub_entry->second) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001542 GetImageLayoutMap(device_data)->erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001543 }
1544 imageSubresourceMap->erase(sub_entry);
1545 }
1546}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001547
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001548bool CoreChecks::ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001549 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001550
1551 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1552 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1553 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 -06001554 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001555 }
1556
Dave Houlton1d2022c2017-03-29 11:43:58 -06001557 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001558 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1559 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 -06001560 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001561 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001562 char const str[] = "vkCmdClearColorImage called with compressed image.";
1563 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 -06001564 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001565 }
1566
1567 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1568 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1569 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 -06001570 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001571 }
1572 return skip;
1573}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001574
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001575uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1576 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1577 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001578 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001579 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001580 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001581 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001582}
1583
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001584uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1585 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1586 uint32_t array_layer_count = range->layerCount;
1587 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1588 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001589 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001590 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001591}
1592
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001593bool CoreChecks::VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
1594 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001595 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001596
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001597 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1598 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001599
1600 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1601 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001602 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1603 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001604 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 -06001605 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001606 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1607 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001608 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001609 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001610 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001611 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 -06001612 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001613 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1614 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001615
1616 } else {
1617 if (image_state->shared_presentable) {
1618 skip |= log_msg(
1619 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001620 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001621 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1622 string_VkImageLayout(dest_image_layout));
1623 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001624 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001625 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001626 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001627 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001628 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001629 } else {
1630 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1631 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001632 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 -06001633 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001634 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1635 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001636 }
1637 }
1638
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001639 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1640 uint32_t level = level_index + range.baseMipLevel;
1641 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1642 uint32_t layer = layer_index + range.baseArrayLayer;
1643 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001644 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001645 if (FindCmdBufLayout(device_data, cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001646 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001647 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001648 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001649 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001650 } else {
1651 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1652 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001653 skip |=
1654 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1655 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1656 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001657 }
1658 }
1659 }
1660 }
1661
1662 return skip;
1663}
1664
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001665void CoreChecks::RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image,
1666 VkImageSubresourceRange range, VkImageLayout dest_image_layout) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001667 VkImageCreateInfo *image_create_info = &(GetImageState(image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001668 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1669 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001670
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001671 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1672 uint32_t level = level_index + range.baseMipLevel;
1673 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1674 uint32_t layer = layer_index + range.baseArrayLayer;
1675 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001676 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001677 if (!FindCmdBufLayout(device_data, cb_node, image, sub, node)) {
1678 SetLayout(device_data, cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001679 }
1680 }
1681 }
1682}
1683
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001684bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1685 const VkClearColorValue *pColor, uint32_t rangeCount,
1686 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001687 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1688
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001689 bool skip = false;
1690 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001691 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001692 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001693 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001694 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearColorImage()",
1695 "VUID-vkCmdClearColorImage-image-00003");
1696 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001697 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001698 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001699 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001700 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1701 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1702 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001703 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001704 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001705 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001706 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001707 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1708 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1709 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001710 }
1711 }
1712 return skip;
1713}
1714
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001715void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1716 const VkClearColorValue *pColor, uint32_t rangeCount,
1717 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001718 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1719
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001720 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001721 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001722 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001723 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001724 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001725 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001726 }
1727 }
1728}
1729
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001730bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1731 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1732 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001733 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001734 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001735
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001736 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001737 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001738 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001739 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001740 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1741 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001742 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001743 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001744 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001745 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04001746 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001747 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1748 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001749 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001750 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001751 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001752 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001753 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001754 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001755 skip |=
1756 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001757 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001758 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1759 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001760 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001761 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1762 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001763 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 -06001764 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001765 }
1766 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001767 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001768 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001769 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 -06001770 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001771 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001772 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1773 char const str[] =
1774 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1775 "set.";
1776 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 -06001777 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001778 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001779 }
1780 return skip;
1781}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001782
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001783void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1784 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1785 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001786 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1787
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001788 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001789 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001790 if (cb_node && image_state) {
1791 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1792 for (uint32_t i = 0; i < rangeCount; ++i) {
1793 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1794 }
1795 }
1796}
1797
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001798// Returns true if [x, xoffset] and [y, yoffset] overlap
1799static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1800 bool result = false;
1801 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1802 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1803
1804 if (intersection_max > intersection_min) {
1805 result = true;
1806 }
1807 return result;
1808}
1809
Dave Houltonc991cc92018-03-06 11:08:51 -07001810// Returns true if source area of first copy region intersects dest area of second region
1811// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1812static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001813 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001814
Dave Houltonc991cc92018-03-06 11:08:51 -07001815 // Separate planes within a multiplane image cannot intersect
1816 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001817 return result;
1818 }
1819
Dave Houltonc991cc92018-03-06 11:08:51 -07001820 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1821 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1822 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001823 result = true;
1824 switch (type) {
1825 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001826 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001827 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001828 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001829 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001830 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001831 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001832 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001833 break;
1834 default:
1835 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1836 assert(false);
1837 }
1838 }
1839 return result;
1840}
1841
Dave Houltonfc1a4052017-04-27 14:32:45 -06001842// Returns non-zero if offset and extent exceed image extents
1843static const uint32_t x_bit = 1;
1844static const uint32_t y_bit = 2;
1845static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001846static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001847 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001848 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001849 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1850 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001851 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001852 }
1853 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1854 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001855 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001856 }
1857 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1858 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001859 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001860 }
1861 return result;
1862}
1863
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001864// Test if two VkExtent3D structs are equivalent
1865static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1866 bool result = true;
1867 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1868 (extent->depth != other_extent->depth)) {
1869 result = false;
1870 }
1871 return result;
1872}
1873
Dave Houltonee281a52017-12-08 13:51:02 -07001874// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1875// Destination image texel extents must be adjusted by block size for the dest validation checks
1876VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1877 VkExtent3D adjusted_extent = extent;
1878 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001879 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001880 adjusted_extent.width /= block_size.width;
1881 adjusted_extent.height /= block_size.height;
1882 adjusted_extent.depth /= block_size.depth;
1883 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001884 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001885 adjusted_extent.width *= block_size.width;
1886 adjusted_extent.height *= block_size.height;
1887 adjusted_extent.depth *= block_size.depth;
1888 }
1889 return adjusted_extent;
1890}
1891
Dave Houlton6f9059e2017-05-02 17:15:13 -06001892// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001893static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1894 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001895
1896 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001897 if (mip >= img->createInfo.mipLevels) {
1898 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001899 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001900
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001901 // 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 -06001902 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001903
Dave Houltone48cd112019-01-03 17:01:18 -07001904 // If multi-plane, adjust per-plane extent
1905 if (FormatIsMultiplane(img->createInfo.format)) {
1906 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1907 extent.width /= divisors.width;
1908 extent.height /= divisors.height;
1909 }
1910
Jeff Bolzef40fec2018-09-01 22:04:34 -05001911 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1912 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001913 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001914 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1915 } else {
1916 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1917 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1918 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1919 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001920
Dave Houlton6f9059e2017-05-02 17:15:13 -06001921 // Image arrays have an effective z extent that isn't diminished by mip level
1922 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001923 extent.depth = img->createInfo.arrayLayers;
1924 }
1925
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001926 return extent;
1927}
1928
1929// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001930static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001931 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1932}
1933
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001934// Test if the extent argument has any dimensions set to 0.
1935static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1936 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1937}
1938
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001939// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001940VkExtent3D CoreChecks::GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001941 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1942 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001943 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001944 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001945 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001946 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001947 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001948 granularity.width *= block_size.width;
1949 granularity.height *= block_size.height;
1950 }
1951 }
1952 return granularity;
1953}
1954
1955// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1956static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1957 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001958 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1959 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001960 valid = false;
1961 }
1962 return valid;
1963}
1964
1965// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001966bool CoreChecks::CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1967 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
1968 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001969 bool skip = false;
1970 VkExtent3D offset_extent = {};
1971 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1972 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1973 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001974 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001975 // 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 -07001976 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001977 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 -04001978 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001979 "%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 "
1980 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001981 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001982 }
1983 } else {
1984 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1985 // integer multiples of the image transfer granularity.
1986 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001987 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 -04001988 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001989 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1990 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001991 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1992 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001993 }
1994 }
1995 return skip;
1996}
1997
1998// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001999bool CoreChecks::CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
2000 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
2001 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
2002 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002003 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07002004 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002005 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
2006 // subresource extent.
2007 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02002008 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 -04002009 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02002010 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
2011 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
2012 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
2013 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002014 }
2015 } else {
2016 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
2017 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
2018 // subresource extent dimensions.
2019 VkExtent3D offset_extent_sum = {};
2020 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
2021 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
2022 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002023 bool x_ok = true;
2024 bool y_ok = true;
2025 bool z_ok = true;
2026 switch (image_type) {
2027 case VK_IMAGE_TYPE_3D:
2028 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2029 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002030 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002031 case VK_IMAGE_TYPE_2D:
2032 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2033 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002034 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002035 case VK_IMAGE_TYPE_1D:
2036 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2037 (subresource_extent->width == offset_extent_sum.width));
2038 break;
2039 default:
2040 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2041 assert(false);
2042 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002043 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002044 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 -04002045 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002046 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2047 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2048 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2049 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2050 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2051 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002052 }
2053 }
2054 return skip;
2055}
2056
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002057bool CoreChecks::ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2058 uint32_t mip_level, const uint32_t i, const char *function, const char *member,
2059 const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002060 bool skip = false;
2061 if (mip_level >= img->createInfo.mipLevels) {
2062 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2063 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07002064 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
2065 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002066 }
2067 return skip;
2068}
2069
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002070bool CoreChecks::ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2071 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i,
2072 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002073 bool skip = false;
2074 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2075 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2076 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2077 HandleToUint64(cb_node->commandBuffer), vuid,
2078 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002079 "%u, but provided image %s has %u array layers.",
2080 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2081 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002082 }
2083 return skip;
2084}
2085
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002086// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002087bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2088 const IMAGE_STATE *img, const VkBufferImageCopy *region,
2089 const uint32_t i, const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002090 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002091 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2092 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2093 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2094 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2095 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002096 return skip;
2097}
2098
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002099// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002100bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2101 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2102 const VkImageCopy *region, const uint32_t i,
2103 const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002104 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002105 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002106 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002107 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2108 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002109 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002110 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002111 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002112 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002113
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002114 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002115 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002116 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2117 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002118 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002119 const VkExtent3D dest_effective_extent =
2120 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002122 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002123 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002124 return skip;
2125}
2126
Dave Houlton6f9059e2017-05-02 17:15:13 -06002127// Validate contents of a VkImageCopy struct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002128bool CoreChecks::ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data,
2129 const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
2130 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002131 bool skip = false;
2132
2133 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002134 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002135
2136 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002137 const VkExtent3D src_copy_extent = region.extent;
2138 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002139 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2140
Dave Houlton6f9059e2017-05-02 17:15:13 -06002141 bool slice_override = false;
2142 uint32_t depth_slices = 0;
2143
2144 // Special case for copying between a 1D/2D array and a 3D image
2145 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2146 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002147 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002148 slice_override = (depth_slices != 1);
2149 } 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 -07002150 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002151 slice_override = (depth_slices != 1);
2152 }
2153
2154 // Do all checks on source image
2155 //
2156 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002157 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2158 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 -06002159 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002160 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002161 "be 0 and 1, respectively.",
2162 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002163 }
2164 }
2165
Dave Houlton533be9f2018-03-26 17:08:30 -06002166 // VUID-VkImageCopy-srcImage-01785
2167 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2168 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 -06002169 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002170 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002171 "these must be 0 and 1, respectively.",
2172 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002173 }
2174
Dave Houlton533be9f2018-03-26 17:08:30 -06002175 // VUID-VkImageCopy-srcImage-01787
2176 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2177 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002178 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002179 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2180 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002181 }
2182
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002183 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002184 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002185 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002186 skip |=
2187 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002188 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002189 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002190 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2191 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002192 }
2193 }
2194 } else { // Pre maint 1
2195 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002196 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002198 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002199 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2200 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002201 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2202 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002203 }
2204 }
2205 }
2206
Dave Houltonc991cc92018-03-06 11:08:51 -07002207 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002208 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002209 if (FormatIsCompressed(src_state->createInfo.format) ||
2210 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002211 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002212 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002213 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2214 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2215 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002216 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002217 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 -07002218 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002220 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002221 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002222 }
2223
Dave Houlton94a00372017-12-14 15:08:47 -07002224 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002225 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2226 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002227 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002228 skip |=
2229 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002230 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002232 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002233 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002234 }
2235
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002236 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002237 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2238 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002239 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002240 skip |=
2241 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002242 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002244 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002245 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002246 }
2247
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002248 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002249 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2250 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002251 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002252 skip |=
2253 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002254 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002255 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002256 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002257 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002258 }
2259 } // Compressed
2260
2261 // Do all checks on dest image
2262 //
2263 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002264 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002265 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 -06002266 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002267 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002268 "these must be 0 and 1, respectively.",
2269 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 }
2271 }
2272
Dave Houlton533be9f2018-03-26 17:08:30 -06002273 // VUID-VkImageCopy-dstImage-01786
2274 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2275 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 -06002276 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002277 "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 -06002278 "and 1, respectively.",
2279 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002280 }
2281
2282 // VUID-VkImageCopy-dstImage-01788
2283 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2284 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 -06002285 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002286 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2287 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002288 }
2289
2290 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002291 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002292 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 -06002293 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002294 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002295 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2296 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002297 }
2298 }
2299 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002300 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002301 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002302 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002303 skip |=
2304 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002305 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002306 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002307 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2308 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 }
2310 }
2311 } else { // Pre maint 1
2312 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002313 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002314 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 -06002315 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002316 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2317 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002318 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2319 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002320 }
2321 }
2322 }
2323
Dave Houltonc991cc92018-03-06 11:08:51 -07002324 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2325 if (FormatIsCompressed(dst_state->createInfo.format) ||
2326 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002327 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002328
2329 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002330 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2331 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2332 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002333 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002334 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 -07002335 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002337 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002338 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002339 }
2340
Dave Houlton94a00372017-12-14 15:08:47 -07002341 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002342 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2343 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002344 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002345 skip |=
2346 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002347 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002348 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002349 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002350 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002351 }
2352
Dave Houltonee281a52017-12-08 13:51:02 -07002353 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2354 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2355 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002356 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002357 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 -07002358 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002359 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2360 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002361 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002362 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002363 }
2364
Dave Houltonee281a52017-12-08 13:51:02 -07002365 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2366 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2367 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002368 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002369 skip |=
2370 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002371 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002372 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002373 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002374 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002375 }
2376 } // Compressed
2377 }
2378 return skip;
2379}
2380
Dave Houltonc991cc92018-03-06 11:08:51 -07002381// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002382bool CoreChecks::CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer,
2383 const IMAGE_STATE *src_image_state, const IMAGE_STATE *dst_image_state,
2384 const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002385 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002386
2387 // Neither image is multiplane
2388 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2389 // If neither image is multi-plane the aspectMask member of src and dst must match
2390 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2391 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002392 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002393 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2394 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 -06002395 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002396 }
2397 } else {
2398 // Source image multiplane checks
2399 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2400 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2401 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2402 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002403 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002404 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 -06002405 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002406 }
2407 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2408 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2409 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002410 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 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 -06002412 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002413 }
2414 // Single-plane to multi-plane
2415 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2416 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2417 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002418 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002419 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 -06002420 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002421 }
2422
2423 // Dest image multiplane checks
2424 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2425 aspect = region.dstSubresource.aspectMask;
2426 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2427 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002428 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002429 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 -06002430 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002431 }
2432 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2433 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2434 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002435 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002436 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002437 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002438 }
2439 // Multi-plane to single-plane
2440 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2441 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2442 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002443 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002444 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 -06002445 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002446 }
2447 }
2448
2449 return skip;
2450}
2451
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002452bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2453 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2454 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002455 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002456 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002457 auto src_image_state = GetImageState(srcImage);
2458 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002459 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002460
2461 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002462
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002463 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2464
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002465 for (uint32_t i = 0; i < regionCount; i++) {
2466 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002467
2468 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2469 VkExtent3D src_copy_extent = region.extent;
2470 VkExtent3D dst_copy_extent =
2471 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2472
Dave Houlton6f9059e2017-05-02 17:15:13 -06002473 bool slice_override = false;
2474 uint32_t depth_slices = 0;
2475
2476 // Special case for copying between a 1D/2D array and a 3D image
2477 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2478 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2479 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002480 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002481 slice_override = (depth_slices != 1);
2482 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2483 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002484 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002485 slice_override = (depth_slices != 1);
2486 }
2487
Cort Strattond619a302018-05-17 19:46:32 -07002488 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2489 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002490 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2491 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2492 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2493 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2494 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2495 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2496 "VUID-vkCmdCopyImage-srcSubresource-01698");
2497 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2498 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2499 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002500
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002501 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002502 // No chance of mismatch if we're overriding depth slice count
2503 if (!slice_override) {
2504 // The number of depth slices in srcSubresource and dstSubresource must match
2505 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2506 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002507 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2508 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002509 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002510 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2511 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002512 if (src_slices != dst_slices) {
2513 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002514 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002515 << "] do not match";
2516 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002517 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002518 }
2519 }
2520 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002521 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002522 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002523 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002524 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002525 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002526 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 -06002527 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002528 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002529 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002530
Dave Houltonc991cc92018-03-06 11:08:51 -07002531 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002532 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002533 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2534 }
2535
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002536 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002537 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2538 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002539 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002540 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-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002542 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002543 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002544
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002545 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002546 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002547 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002548 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002549 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2550 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002551 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002552 }
2553
2554 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002555 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002556 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002557 ss << "vkCmdCopyImage(): pRegion[" << i
2558 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002559 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 -06002560 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002561 }
2562
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002563 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2564 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2565 // 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 -07002566 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2567 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002568 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002569 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002570 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2571 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2572 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002573 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 -06002574 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002575 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002576
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002577 // 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 -07002578 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2579 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002580 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002581 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002582 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2583 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2584 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002585 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002586 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002587 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002588 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002589
Dave Houltonfc1a4052017-04-27 14:32:45 -06002590 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002591 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2592 if (slice_override) src_copy_extent.depth = depth_slices;
2593 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002594 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002595 skip |=
2596 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2597 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2598 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2599 "width [%1d].",
2600 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002601 }
2602
2603 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002604 skip |=
2605 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2606 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2607 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2608 "height [%1d].",
2609 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002610 }
2611 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002612 skip |=
2613 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2614 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2615 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2616 "depth [%1d].",
2617 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002618 }
2619
Dave Houltonee281a52017-12-08 13:51:02 -07002620 // Adjust dest extent if necessary
2621 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2622 if (slice_override) dst_copy_extent.depth = depth_slices;
2623
2624 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002625 if (extent_check & x_bit) {
2626 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 -06002627 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002628 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002629 "width [%1d].",
2630 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002631 }
2632 if (extent_check & y_bit) {
2633 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 -06002634 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002635 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002636 "height [%1d].",
2637 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002638 }
2639 if (extent_check & z_bit) {
2640 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 -06002641 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002642 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002643 "depth [%1d].",
2644 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002645 }
2646
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002647 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2648 // must not overlap in memory
2649 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002650 for (uint32_t j = 0; j < regionCount; j++) {
2651 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002652 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002653 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002654 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002655 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 -06002656 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002657 }
2658 }
2659 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002660 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002661
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002662 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2663 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2664 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002665 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002666 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2667 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002668 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 -06002669 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002670 }
2671 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002672 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002673 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2674 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 -06002675 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002676 }
2677 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002678
Dave Houlton33c22b72017-02-28 13:16:02 -07002679 // Source and dest image sample counts must match
2680 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2681 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2682 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 -06002683 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002684 }
2685
Dave Houltond8ed0212018-05-16 17:18:24 -06002686 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2687 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002688 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002689 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2690 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2691 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2692 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002693 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002694 skip |=
2695 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002696 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002697 skip |=
2698 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002699 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002700 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002701 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002702 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2703 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002704 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002705 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002706 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002707 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002708 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002709 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2710 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002711 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002712 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002713 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2714 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002715 for (uint32_t i = 0; i < regionCount; ++i) {
2716 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002717 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2718 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002719 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002720 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2721 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002722 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002723 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002724 }
2725
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002726 return skip;
2727}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002728
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002729void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2730 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2731 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002732 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002733 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002734 auto src_image_state = GetImageState(srcImage);
2735 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002736
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002737 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002738 for (uint32_t i = 0; i < regionCount; ++i) {
2739 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2740 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002741 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002742 // Update bindings between images and cmd buffer
2743 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2744 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002745}
2746
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002747// Returns true if sub_rect is entirely contained within rect
2748static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2749 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2750 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2751 return false;
2752 return true;
2753}
2754
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002755bool CoreChecks::ValidateClearAttachmentExtent(layer_data *device_data, VkCommandBuffer command_buffer, uint32_t attachment_index,
2756 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2757 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002758 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002759 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2760 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002761 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002762 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002763
2764 for (uint32_t j = 0; j < rect_count; j++) {
2765 if (!ContainsRect(render_area, clear_rects[j].rect)) {
2766 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2767 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2768 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2769 "the current render pass instance.",
2770 j);
2771 }
2772
2773 if (image_view_state) {
2774 // The layers specified by a given element of pRects must be contained within every attachment that
2775 // pAttachments refers to
2776 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2777 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2778 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
2779 skip |=
2780 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2781 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2782 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2783 "of pAttachment[%d].",
2784 j, attachment_index);
2785 }
2786 }
2787 }
2788 return skip;
2789}
2790
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002791bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2792 const VkClearAttachment *pAttachments, uint32_t rectCount,
2793 const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002794 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2795
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002796 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002797
2798 bool skip = false;
2799 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002800 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002801 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002802 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002803 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002804 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002805 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2806 // 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 -07002807 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2808 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002809 skip |=
2810 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2811 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2812 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2813 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2814 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002815 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002816 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002817 }
2818
2819 // Validate that attachment is in reference list of active subpass
2820 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002821 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002822 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002823 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002824 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002825 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2826 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002827
John Zulauf3a548ef2019-02-01 16:14:07 -07002828 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2829 auto clear_desc = &pAttachments[attachment_index];
2830 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002831
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002832 if (0 == clear_desc->aspectMask) {
2833 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002834 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002835 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2836 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 -06002837 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002838 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002839 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2840 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2841 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2842 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002843 skip |= log_msg(
2844 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2845 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2846 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2847 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2848 attachment_index, clear_desc->colorAttachment,
2849 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2850 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2851
John Zulauff2582972019-02-09 14:53:30 -07002852 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2853 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002854 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002855 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2856 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2857 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2858 " subpass %u. colorAttachmentCount=%u",
2859 attachment_index, clear_desc->colorAttachment,
2860 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2861 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002862 }
John Zulauff2582972019-02-09 14:53:30 -07002863 fb_attachment = color_attachment;
2864
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002865 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2866 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2867 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002868 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002869 skip |=
2870 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2871 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002872 }
2873 } else { // Must be depth and/or stencil
2874 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2875 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002876 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002877 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 -07002878 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2879 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002880 }
2881 if (!subpass_desc->pDepthStencilAttachment ||
2882 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2883 skip |= log_msg(
2884 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002885 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002886 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002887 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002888 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002889 }
2890 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002891 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002892 skip |= ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2893 render_area, rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002894 } else {
2895 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2896 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2897 if (!clear_rect_copy) {
2898 // We need a copy of the clear rectangles that will persist until the last lambda executes
2899 // but we want to create it as lazily as possible
2900 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002901 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002902
2903 auto val_fn = [device_data, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
2904 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2905 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002906 FRAMEBUFFER_STATE *framebuffer = device_data->GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002907 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2908 bool skip = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002909 skip =
2910 device_data->ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer,
2911 fb_attachment, render_area, rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002912 return skip;
2913 };
2914 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002915 }
2916 }
2917 }
2918 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002919}
2920
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002921bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2922 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2923 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002924 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002925 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002926 auto src_image_state = GetImageState(srcImage);
2927 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002928
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002929 bool skip = false;
2930 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002931 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2932 "VUID-vkCmdResolveImage-srcImage-00256");
2933 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2934 "VUID-vkCmdResolveImage-dstImage-00258");
2935 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2936 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002937 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002938 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002939 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002940 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2941 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002942
Cort Stratton7df30962018-05-17 19:45:57 -07002943 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002944 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002945 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002946 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2947 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2948 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002949 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002950 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2951 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002952 // For each region, the number of layers in the image subresource should not be zero
2953 // For each region, src and dest image aspect must be color only
2954 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002955 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2956 "srcSubresource", i);
2957 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2958 "dstSubresource", i);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002959 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002960 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2961 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002962 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002963 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2964 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002965 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2966 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2967 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2968 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2969 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2970 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2971 "VUID-vkCmdResolveImage-srcSubresource-01711");
2972 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2973 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2974 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002975
2976 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002977 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2978 skip |= log_msg(
2979 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002980 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002981 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002982 }
Cort Stratton7df30962018-05-17 19:45:57 -07002983 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002984 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2985 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2986 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002987 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002988 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 -06002989 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002990 }
2991 }
2992
2993 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2994 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002995 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 -06002996 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002997 }
2998 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2999 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07003000 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 -06003001 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003002 }
3003 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
3004 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
3005 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003006 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003007 }
3008 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
3009 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
3010 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 -06003011 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07003012 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003013 } else {
3014 assert(0);
3015 }
3016 return skip;
3017}
3018
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003019void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3020 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3021 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003022 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003023 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003024 auto src_image_state = GetImageState(srcImage);
3025 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003026
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003027 // Update bindings between images and cmd buffer
3028 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3029 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003030}
3031
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003032bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3033 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3034 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003035 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003036 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003037 auto src_image_state = GetImageState(srcImage);
3038 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003039
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003040 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003041 if (cb_node) {
3042 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3043 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003044 if (cb_node && src_image_state && dst_image_state) {
3045 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003046 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003047 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003048 "VUID-vkCmdBlitImage-dstImage-00234");
3049 skip |=
3050 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3051 skip |=
3052 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
3053 skip |=
3054 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3055 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3056 skip |=
3057 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3058 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3059 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
3060 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003061 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003062 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003063 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003064 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003065 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003066 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003067
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003068 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003069
Dave Houlton33c2d252017-06-09 17:08:32 -06003070 VkFormat src_format = src_image_state->createInfo.format;
3071 VkFormat dst_format = dst_image_state->createInfo.format;
3072 VkImageType src_type = src_image_state->createInfo.imageType;
3073 VkImageType dst_type = dst_image_state->createInfo.imageType;
3074
Cort Stratton186b1a22018-05-01 20:18:06 -04003075 if (VK_FILTER_LINEAR == filter) {
3076 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003077 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3078 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003079 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003080 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3081 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003082 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003083 }
3084
3085 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3086 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 -06003087 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003088 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003089 }
3090
Dave Houlton33c2d252017-06-09 17:08:32 -06003091 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3092 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3093 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003094 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003095 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003096 }
3097
3098 // Validate consistency for unsigned formats
3099 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3100 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003101 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003102 << "the other one must also have unsigned integer format. "
3103 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3104 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 -06003105 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003106 }
3107
3108 // Validate consistency for signed formats
3109 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3110 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003111 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 << "the other one must also have signed integer format. "
3113 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3114 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 -06003115 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003116 }
3117
3118 // Validate filter for Depth/Stencil formats
3119 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3120 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003121 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003122 << "then filter must be VK_FILTER_NEAREST.";
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-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003125 }
3126
3127 // Validate aspect bits and formats for depth/stencil images
3128 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3129 if (src_format != dst_format) {
3130 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003131 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003132 << "stencil, the other one must have exactly the same format. "
3133 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3134 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003135 skip |=
3136 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3137 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003138 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003139 } // Depth or Stencil
3140
3141 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003142 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003143 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003144 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3145 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3146 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003147 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003148 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3149 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003150 for (uint32_t i = 0; i < regionCount; i++) {
3151 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003152 bool hit_error = false;
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003153 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003154 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3155 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003156 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003157 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3158 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003159 skip |=
3160 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3161 skip |=
3162 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003163 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3164 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3165 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3166 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3167 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3168 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3169 "VUID-vkCmdBlitImage-srcSubresource-01707");
3170 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3171 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3172 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003173 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003174 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3175 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003176 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003177 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003178 skip |=
3179 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3180 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003181 }
Dave Houlton48989f32017-05-26 15:01:46 -06003182 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3183 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003184 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003185 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003186 skip |=
3187 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3188 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003189 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003190
3191 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003192 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003193 skip |= log_msg(
3194 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3195 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3196 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003197 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003198
Dave Houlton48989f32017-05-26 15:01:46 -06003199 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003200 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 -06003201 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003202 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003203 }
Dave Houlton48989f32017-05-26 15:01:46 -06003204
Dave Houlton33c2d252017-06-09 17:08:32 -06003205 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3206 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 -06003207 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003208 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003209 "image format %s.",
3210 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003211 }
3212
3213 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3214 skip |= log_msg(
3215 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003216 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003217 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3218 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003219 }
3220
Dave Houlton48989f32017-05-26 15:01:46 -06003221 // Validate source image offsets
3222 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003223 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003224 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
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-00245",
3228 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3229 "of (%1d, %1d). These must be (0, 1).",
3230 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003231 }
3232 }
3233
Dave Houlton33c2d252017-06-09 17:08:32 -06003234 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003235 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3236 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 -06003237 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003238 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003239 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3240 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003241 }
3242 }
3243
Dave Houlton33c2d252017-06-09 17:08:32 -06003244 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003245 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3246 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003247 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003248 skip |= log_msg(
3249 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3250 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3251 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3252 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003253 }
3254 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3255 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003256 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003257 skip |= log_msg(
3258 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003259 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003260 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003261 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003262 }
3263 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3264 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003265 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003266 skip |= log_msg(
3267 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3268 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3269 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3270 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003271 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003272 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003273 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 -06003274 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003275 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003276 }
Dave Houlton48989f32017-05-26 15:01:46 -06003277
3278 // Validate dest image offsets
3279 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003280 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003281 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003282 skip |=
3283 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3284 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3285 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3286 "(%1d, %1d). These must be (0, 1).",
3287 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003288 }
3289 }
3290
Dave Houlton33c2d252017-06-09 17:08:32 -06003291 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003292 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3293 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 -06003294 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003295 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003296 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3297 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003298 }
3299 }
3300
Dave Houlton33c2d252017-06-09 17:08:32 -06003301 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003302 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3303 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003304 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003305 skip |= log_msg(
3306 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3307 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3308 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3309 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003310 }
3311 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3312 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003313 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003314 skip |= log_msg(
3315 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003316 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003317 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003318 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003319 }
3320 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3321 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003322 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003323 skip |= log_msg(
3324 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3325 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3326 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3327 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003328 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003329 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003330 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 -06003331 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003332 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003333 }
3334
Dave Houlton33c2d252017-06-09 17:08:32 -06003335 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3336 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3337 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003338 skip |=
3339 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3340 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3341 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3342 "layerCount other than 1.",
3343 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003344 }
3345 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003346 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003347 } else {
3348 assert(0);
3349 }
3350 return skip;
3351}
3352
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003353void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3354 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3355 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003356 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003357 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003358 auto src_image_state = GetImageState(srcImage);
3359 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003360
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003361 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003362 for (uint32_t i = 0; i < regionCount; ++i) {
3363 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3364 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003365 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003366 // Update bindings between images and cmd buffer
3367 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3368 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003369}
3370
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003371// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003372bool CoreChecks::ValidateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB,
3373 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3374 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003375 bool skip = false;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003376 for (auto cb_image_data : pCB->imageLayoutMap) {
3377 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003378
Dave Houltonb3f4b282018-02-22 16:25:16 -07003379 if (FindLayout(device_data, overlayLayoutMap, cb_image_data.first, imageLayout) ||
3380 FindLayout(device_data, globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003381 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3382 // TODO: Set memory invalid which is in mem_tracker currently
3383 } else if (imageLayout != cb_image_data.second.initialLayout) {
3384 if (cb_image_data.first.hasSubresource) {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003385 skip |=
3386 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3387 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07003388 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level "
3389 "%u) to be in layout %s--instead, image %s's current layout is %s.",
3390 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3391 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
3392 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(cb_image_data.second.initialLayout),
3393 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
3394 } else {
3395 skip |= log_msg(
3396 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3397 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3398 "Submitted command buffer expects image %s to be in layout %s--instead, image %s's current layout is %s.",
3399 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3400 string_VkImageLayout(cb_image_data.second.initialLayout),
3401 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003402 }
3403 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003404 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003405 }
3406 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003407 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003408}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003409
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003410void CoreChecks::UpdateCmdBufImageLayouts(layer_data *device_data, GLOBAL_CB_NODE *pCB) {
Tony Barbourdf013b92017-01-25 12:53:48 -07003411 for (auto cb_image_data : pCB->imageLayoutMap) {
3412 VkImageLayout imageLayout;
3413 FindGlobalLayout(device_data, cb_image_data.first, imageLayout);
3414 SetGlobalLayout(device_data, cb_image_data.first, cb_image_data.second.layout);
3415 }
3416}
3417
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003418// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003419// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3420// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003421bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3422 const VkImageLayout first_layout, const uint32_t attachment,
3423 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003424 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003425 const char *vuid;
3426 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3427
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003428 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3429 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003430 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3431 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3432 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003433 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003434 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3435 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3436 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3437 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3438 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3439 skip |=
3440 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3441 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003442 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003443 }
3444 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003445 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3446 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003447 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003448 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003449 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 -06003450 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003451 }
3452 }
3453
3454 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3455 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003456 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003457 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003458 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 -06003459 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003460 }
3461 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003462 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003463}
3464
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003465bool CoreChecks::ValidateLayouts(layer_data *device_data, RenderPassCreateVersion rp_version, VkDevice device,
3466 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003467 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003468 const char *vuid;
3469 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3470 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003471
Jason Ekstranda1906302017-12-03 20:16:32 -08003472 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3473 VkFormat format = pCreateInfo->pAttachments[i].format;
3474 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3475 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3476 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003477 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 -06003478 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003479 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3480 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3481 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3482 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003483 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003484 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003485 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 -06003486 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003487 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3488 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3489 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3490 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003491 }
3492 }
3493 }
3494
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003495 // Track when we're observing the first use of an attachment
3496 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3497 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003498 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003499
3500 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3501 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3502 auto attach_index = subpass.pInputAttachments[j].attachment;
3503 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003504 switch (subpass.pInputAttachments[j].layout) {
3505 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3506 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3507 // These are ideal.
3508 break;
3509
3510 case VK_IMAGE_LAYOUT_GENERAL:
3511 // May not be optimal. TODO: reconsider this warning based on other constraints.
3512 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003513 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003514 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3515 break;
3516
Tobias Hectorbbb12282018-10-22 15:17:59 +01003517 case VK_IMAGE_LAYOUT_UNDEFINED:
3518 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3519 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3520 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3521 "Layout for input attachment reference %u in subpass %u is %s but must be "
3522 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3523 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3524 break;
3525
Graeme Leese668a9862018-10-08 10:40:02 +01003526 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3527 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003528 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003529 break;
3530 } else {
3531 // Intentionally fall through to generic error message
3532 }
3533 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003534
Cort Stratton7547f772017-05-04 15:18:52 -07003535 default:
3536 // No other layouts are acceptable
3537 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 -06003538 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003539 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3540 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3541 }
3542
Cort Stratton7547f772017-05-04 15:18:52 -07003543 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003544 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3545 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003546
3547 bool used_as_depth =
3548 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3549 bool used_as_color = false;
3550 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3551 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3552 }
3553 if (!used_as_depth && !used_as_color &&
3554 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003555 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3556 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3557 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3558 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003559 }
3560 }
3561 attach_first_use[attach_index] = false;
3562 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003563
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003564 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3565 auto attach_index = subpass.pColorAttachments[j].attachment;
3566 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3567
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003568 // TODO: Need a way to validate shared presentable images here, currently just allowing
3569 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3570 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003571 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003572 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003573 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003574 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3575 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003576 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003577
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003578 case VK_IMAGE_LAYOUT_GENERAL:
3579 // May not be optimal; TODO: reconsider this warning based on other constraints?
3580 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003581 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003582 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3583 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003584
Tobias Hectorbbb12282018-10-22 15:17:59 +01003585 case VK_IMAGE_LAYOUT_UNDEFINED:
3586 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3587 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3588 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3589 "Layout for color attachment reference %u in subpass %u is %s but should be "
3590 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3591 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3592 break;
3593
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003594 default:
3595 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 -06003596 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003597 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3598 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003599 }
3600
John Zulauf4eee2692019-02-09 16:14:25 -07003601 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3602 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3603 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003604 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3605 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 -07003606 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003607 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003608 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003609 }
3610
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003611 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003612 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3613 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003614 }
3615 attach_first_use[attach_index] = false;
3616 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003617
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003618 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3619 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003620 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3621 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3622 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003623 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003624
Dave Houltona9df0ce2018-02-07 10:51:23 -07003625 case VK_IMAGE_LAYOUT_GENERAL:
3626 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3627 // doing a bunch of transitions.
3628 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003629 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003630 "GENERAL layout for depth attachment may not give optimal performance.");
3631 break;
3632
Tobias Hectorbbb12282018-10-22 15:17:59 +01003633 case VK_IMAGE_LAYOUT_UNDEFINED:
3634 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3635 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3636 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3637 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3638 "layout or GENERAL.",
3639 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3640 break;
3641
Dave Houltona9df0ce2018-02-07 10:51:23 -07003642 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3643 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003644 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003645 break;
3646 } else {
3647 // Intentionally fall through to generic error message
3648 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003649 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003650
Dave Houltona9df0ce2018-02-07 10:51:23 -07003651 default:
3652 // No other layouts are acceptable
3653 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 -06003654 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003655 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3656 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3657 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003658 }
3659
3660 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3661 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003662 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3663 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003664 }
3665 attach_first_use[attach_index] = false;
3666 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003667 }
3668 return skip;
3669}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003670
3671// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003672bool CoreChecks::ValidateMapImageLayouts(layer_data *device_data, VkDevice device, DEVICE_MEM_INFO const *mem_info,
3673 VkDeviceSize offset, VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003674 bool skip = false;
3675 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3676 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003677 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3678 for (auto image_handle : mem_info->bound_images) {
3679 auto img_it = mem_info->bound_ranges.find(image_handle);
3680 if (img_it != mem_info->bound_ranges.end()) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003681 if (RangesIntersect(device_data, &img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003682 std::vector<VkImageLayout> layouts;
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003683 if (FindLayouts(device_data, VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003684 for (auto layout : layouts) {
3685 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003686 skip |=
3687 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 -06003688 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003689 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3690 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003691 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003692 }
3693 }
3694 }
3695 }
3696 }
3697 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003698 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003699}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003700
3701// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3702// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003703bool CoreChecks::ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict,
3704 uint64_t obj_handle, VulkanObjectType obj_type, const char *msgCode, char const *func_name,
3705 char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003706 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003707 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003708 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003709 if (strict) {
3710 correct_usage = ((actual & desired) == desired);
3711 } else {
3712 correct_usage = ((actual & desired) != 0);
3713 }
3714 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003715 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003716 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003717 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3718 kVUID_Core_MemTrack_InvalidUsageFlag,
3719 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3720 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003721 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003722 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3723 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3724 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003725 }
3726 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003727 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003728}
3729
3730// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3731// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003732bool CoreChecks::ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
3733 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003734 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3735 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003736}
3737
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003738bool CoreChecks::ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
3739 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003740 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003741 bool skip = false;
3742 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3743 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003744 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3745 HandleToUint64(image_state->image), linear_vuid,
3746 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3747 format_properties.linearTilingFeatures, image_state->createInfo.format,
3748 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003749 }
3750 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3751 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3752 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3753 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003754 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003755 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003756 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003757 }
3758 }
3759 return skip;
3760}
3761
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003762bool CoreChecks::ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3763 const VkImageSubresourceLayers *subresource_layers, char const *func_name,
3764 char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003765 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003766 // layerCount must not be zero
3767 if (subresource_layers->layerCount == 0) {
3768 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3769 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3770 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3771 }
3772 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3773 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3774 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3775 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3776 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3777 }
3778 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3779 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3780 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3781 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3782 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3783 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3784 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3785 func_name, i, member);
3786 }
3787 return skip;
3788}
3789
Mark Lobodzinski96210742017-02-09 10:33:46 -07003790// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3791// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003792bool CoreChecks::ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired,
3793 bool strict, const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003794 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3795 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003796}
3797
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003798bool CoreChecks::ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3799 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003800 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003801
3802 const VkDeviceSize &range = pCreateInfo->range;
3803 if (range != VK_WHOLE_SIZE) {
3804 // Range must be greater than 0
3805 if (range <= 0) {
3806 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3807 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3808 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3809 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3810 range);
3811 }
3812 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003813 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003814 if (range % format_size != 0) {
3815 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3816 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3817 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3818 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3819 "(" PRINTF_SIZE_T_SPECIFIER ").",
3820 range, format_size);
3821 }
3822 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3823 if (range / format_size > device_limits->maxTexelBufferElements) {
3824 skip |=
3825 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3826 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3827 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3828 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3829 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3830 range, format_size, device_limits->maxTexelBufferElements);
3831 }
3832 // The sum of range and offset must be less than or equal to the size of buffer
3833 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3834 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3835 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3836 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3837 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3838 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3839 range, pCreateInfo->offset, buffer_state->createInfo.size);
3840 }
3841 }
3842 return skip;
3843}
3844
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003845bool CoreChecks::ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3846 const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003847 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003848 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003849 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3850 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3851 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3852 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3853 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3854 "be supported for uniform texel buffers");
3855 }
3856 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3857 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3858 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3859 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3860 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3861 "be supported for storage texel buffers");
3862 }
3863 return skip;
3864}
3865
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003866bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3867 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003868 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3869
Mark Lobodzinski96210742017-02-09 10:33:46 -07003870 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003871
Dave Houltond8ed0212018-05-16 17:18:24 -06003872 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003873
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003874 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003875 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06003876 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003877 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003878 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003879 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003880
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003881 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003882 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06003883 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003884 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003885 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003886 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003887
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003888 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003889 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
Dave Houltond8ed0212018-05-16 17:18:24 -06003890 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003891 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003892 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003893 }
Jeff Bolz87697532019-01-11 22:54:00 -06003894
3895 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3896 if (chained_devaddr_struct) {
3897 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3898 chained_devaddr_struct->deviceAddress != 0) {
3899 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3900 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3901 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3902 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3903 }
3904 }
3905
3906 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003907 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003908 skip |= log_msg(
3909 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3910 "VUID-VkBufferCreateInfo-flags-02605",
3911 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3912 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3913 }
3914
3915 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003916 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003917 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3918 "VUID-VkBufferCreateInfo-usage-02606",
3919 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3920 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3921 }
3922
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003923 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003924 skip |=
3925 ValidateQueueFamilies(device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
3926 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3927 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003928 }
3929
Mark Lobodzinski96210742017-02-09 10:33:46 -07003930 return skip;
3931}
3932
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003933void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3934 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003935 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003936 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003937 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
3938 GetBufferMap(device_data)
3939 ->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
3940}
3941
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003942bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3943 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003944 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3945
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003946 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003947 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003948 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3949 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003950 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3951 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003952 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3953 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003954 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3955 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3956 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3957 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003958
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003959 // Buffer view offset must be less than the size of buffer
3960 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3961 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3962 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3963 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3964 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3965 pCreateInfo->offset, buffer_state->createInfo.size);
3966 }
3967
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003968 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003969 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3970 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3971 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3972 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3973 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3974 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3975 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3976 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003977
3978 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003979
3980 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003981 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003982 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003983}
3984
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003985void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3986 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003987 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003988 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003989 (*GetBufferViewMap(device_data))[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
3990}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003991
3992// For the given format verify that the aspect masks make sense
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003993bool CoreChecks::ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format,
3994 VkImageAspectFlags aspect_mask, const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003995 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003996 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3997 if (image != VK_NULL_HANDLE) {
3998 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3999 }
4000
Dave Houlton1d2022c2017-03-29 11:43:58 -06004001 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004002 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004003 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004004 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004005 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004006 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004007 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004008 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004009 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004010 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004011 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07004012 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004013 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4014 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004015 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004016 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07004017 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004018 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
4019 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004020 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004021 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004022 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004023 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004024 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004025 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004026 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004027 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004028 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06004029 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004030 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004031 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004032 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004033 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004034 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004035 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004036 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004037 } else if (FormatIsMultiplane(format)) {
4038 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4039 if (3 == FormatPlaneCount(format)) {
4040 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4041 }
4042 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004043 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004044 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4045 "set, where n = [0, 1, 2].",
4046 func_name);
4047 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004048 }
4049 return skip;
4050}
4051
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004052bool CoreChecks::ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count,
4053 const uint32_t image_layer_count, const VkImageSubresourceRange &subresourceRange,
4054 const char *cmd_name, const char *param_name, const char *image_layer_count_var_name,
4055 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004056 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004057
4058 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004059 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004060 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 -06004061 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004062 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004063 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4064 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004065 }
Petr Kraus4d718682017-05-18 03:38:41 +02004066
Petr Krausffa94af2017-08-08 21:46:02 +02004067 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4068 if (subresourceRange.levelCount == 0) {
4069 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 -06004070 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004071 } else {
4072 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004073
Petr Krausffa94af2017-08-08 21:46:02 +02004074 if (necessary_mip_count > image_mip_count) {
4075 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 -06004076 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004077 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004078 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004079 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004080 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004081 }
Petr Kraus4d718682017-05-18 03:38:41 +02004082 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004083 }
Petr Kraus4d718682017-05-18 03:38:41 +02004084
4085 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004086 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004087 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 -06004088 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004089 "%s: %s.baseArrayLayer (= %" PRIu32
4090 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4091 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004092 }
Petr Kraus4d718682017-05-18 03:38:41 +02004093
Petr Krausffa94af2017-08-08 21:46:02 +02004094 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4095 if (subresourceRange.layerCount == 0) {
4096 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 -06004097 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004098 } else {
4099 const uint64_t necessary_layer_count =
4100 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004101
Petr Krausffa94af2017-08-08 21:46:02 +02004102 if (necessary_layer_count > image_layer_count) {
4103 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 -06004104 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004105 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004106 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004107 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004108 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004109 }
Petr Kraus4d718682017-05-18 03:38:41 +02004110 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004111 }
Petr Kraus4d718682017-05-18 03:38:41 +02004112
Mark Lobodzinski602de982017-02-09 11:01:33 -07004113 return skip;
4114}
4115
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004116bool CoreChecks::ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4117 bool is_imageview_2d_type,
4118 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004119 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004120 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4121 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4122 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4123
4124 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4125 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4126
4127 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004128 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4129 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4130 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4131 : "VUID-VkImageViewCreateInfo-image-01482")
4132 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4133 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4134 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4135 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4136 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004137
4138 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4139 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4140 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4141}
4142
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004143bool CoreChecks::ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4144 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004145 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004146 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4147 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4148 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4149 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004150
4151 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4152 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4153 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4154}
4155
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004156bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4157 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004158 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004159 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4160 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4161 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4162 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004163
4164 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4165 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4166 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4167}
4168
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004169bool CoreChecks::ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4170 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4171 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004172 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004173 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4174 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4175 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4176 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004177
4178 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4179 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4180 subresourceRangeErrorCodes);
4181}
4182
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004183bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4184 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004185 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004186 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004187 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004188 if (image_state) {
4189 skip |= ValidateImageUsageFlags(
4190 device_data, image_state,
4191 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004192 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4193 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004194 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004195 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004196 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004197 skip |=
4198 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004199 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004200 skip |= ValidateCreateImageViewSubresourceRange(
4201 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004202 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4203 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004204
4205 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4206 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004207 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4208 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004209 VkFormat view_format = pCreateInfo->format;
4210 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004211 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004212 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004213
Dave Houltonbd2e2622018-04-10 16:41:14 -06004214 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004215 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004216 if (chained_ivuci_struct) {
4217 if (chained_ivuci_struct->usage & ~image_usage) {
4218 std::stringstream ss;
4219 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004220 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004221 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004222 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 -07004223 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004224 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004225 }
4226
4227 image_usage = chained_ivuci_struct->usage;
4228 }
4229
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004230 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4231 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004232 if (FormatIsMultiplane(image_format)) {
4233 // View format must match the multiplane compatible format
4234 uint32_t plane = 3; // invalid
4235 switch (aspect_mask) {
4236 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4237 plane = 0;
4238 break;
4239 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4240 plane = 1;
4241 break;
4242 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4243 plane = 2;
4244 break;
4245 default:
4246 break;
4247 }
4248
4249 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4250 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004251 std::stringstream ss;
4252 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004253 << " is not compatible with plane " << plane << " of underlying image format "
4254 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004255 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 -07004256 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004257 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004258 }
4259 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004260 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004261 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4262 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4263 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4264 std::stringstream ss;
4265 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004266 << " is not in the same format compatibility class as image ("
4267 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004268 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4269 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004270 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 -07004271 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004272 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004273 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004274 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004275 }
4276 } else {
4277 // Format MUST be IDENTICAL to the format the image was created with
4278 if (image_format != view_format) {
4279 std::stringstream ss;
4280 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004281 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004282 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004283 skip |=
4284 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004285 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004286 }
4287 }
4288
4289 // Validate correct image aspect bits for desired formats and format consistency
4290 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004291
4292 switch (image_type) {
4293 case VK_IMAGE_TYPE_1D:
4294 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004295 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004296 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004297 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4298 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004299 }
4300 break;
4301 case VK_IMAGE_TYPE_2D:
4302 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4303 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4304 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004305 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004306 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004307 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4308 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004309 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004310 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 -07004311 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004312 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4313 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004314 }
4315 }
4316 break;
4317 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004318 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004319 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4320 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4321 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004322 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004323 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004324 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004325 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4326 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004327 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4328 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004329 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004330 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004331 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004332 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4333 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004334 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4335 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004336 }
4337 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004338 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 -07004339 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004340 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4341 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004342 }
4343 }
4344 } else {
4345 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004346 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 -07004347 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004348 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4349 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004350 }
4351 }
4352 break;
4353 default:
4354 break;
4355 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004356
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004357 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004358 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004359 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004360 }
4361
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004362 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004363 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4364 : format_properties.optimalTilingFeatures;
4365
4366 if (tiling_features == 0) {
4367 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 -07004368 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004369 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4370 "physical device.",
4371 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4372 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4373 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004374 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004375 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4376 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4377 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4378 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4379 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 -07004380 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004381 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4382 "VK_IMAGE_USAGE_STORAGE_BIT.",
4383 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4384 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4385 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4386 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 -07004387 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004388 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4389 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4390 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4391 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4392 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4393 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 -07004394 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004395 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4396 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4397 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004398 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004399
Jeff Bolz9af91c52018-09-01 21:53:57 -05004400 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4401 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4402 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 -07004403 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004404 "vkCreateImageView() If image was created with usage containing "
4405 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4406 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4407 }
4408 if (view_format != VK_FORMAT_R8_UINT) {
4409 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 -07004410 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004411 "vkCreateImageView() If image was created with usage containing "
4412 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4413 }
4414 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004415 }
4416 return skip;
4417}
4418
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004419void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4420 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004421 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004422 if (result != VK_SUCCESS) return;
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004423 auto image_view_map = GetImageViewMap(device_data);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004424 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004425
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004426 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004427 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004428 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4429 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004430}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004431
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004432bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4433 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004434 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004435 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004436 auto src_buffer_state = GetBufferState(srcBuffer);
4437 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004438
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004439 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004440 skip |=
4441 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4442 skip |=
4443 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004444 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004445 skip |=
4446 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4447 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4448 skip |=
4449 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4450 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004451 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004452 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4453 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004454 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004455 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004456 return skip;
4457}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004458
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004459void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4460 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004461 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004462 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004463 auto src_buffer_state = GetBufferState(srcBuffer);
4464 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004465
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004466 // Update bindings between buffers and cmd buffer
4467 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4468 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004469}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004470
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004471bool CoreChecks::ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004472 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004473 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004474 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004475 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 -07004476 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4477 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004478 } else {
4479 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004480 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 -06004481 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004482 "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 -07004483 }
4484 }
4485 return skip;
4486}
4487
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004488bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004489 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004490 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004491 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4492
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004493 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004494 if (image_view_state) {
4495 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004496 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004497 }
4498 return skip;
4499}
4500
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004501void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004502 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004503 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004504 if (!image_view_state) return;
4505 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4506
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004507 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004508 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004509 (*GetImageViewMap(device_data)).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004510}
4511
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004512bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004513 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004514 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004515
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004516 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004517 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004518 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004519 }
4520 return skip;
4521}
4522
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004523void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004524 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4525 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004526 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004527 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4528
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004529 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004530 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004531 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004532 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004533 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004534 }
4535 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004536 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004537 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004538 GetBufferMap(device_data)->erase(buffer_state->buffer);
4539}
4540
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004541bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4542 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004543 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004544 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004545 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004546 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004547 if (buffer_view_state) {
4548 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004549 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004550 }
4551 return skip;
4552}
4553
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004554void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004555 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4556 if (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004557 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004558 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4559
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004560 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004561 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004562 GetBufferViewMap(device_data)->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004563}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004564
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004565bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4566 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004567 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004568 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004569 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004570 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004571 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004572 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004573 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4574 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004575 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4576 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004577 skip |=
4578 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4579 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004580 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004581 return skip;
4582}
4583
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004584void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4585 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004586 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004587 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004588 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004589 // Update bindings between buffer and cmd buffer
4590 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004591}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004592
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004593bool CoreChecks::ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount,
4594 const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004595 bool skip = false;
4596
4597 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004598 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4599 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004600 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-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004602 "%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 -06004603 "and 1, respectively.",
4604 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004605 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004606 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004607
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004608 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4609 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004610 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 -06004611 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004612 "%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 -06004613 "must be 0 and 1, respectively.",
4614 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004615 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004616 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004617
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004618 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4619 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004620 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 -06004621 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004622 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4623 "For 3D images these must be 0 and 1, respectively.",
4624 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004625 }
4626 }
4627
4628 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004629 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4630 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4631 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004632 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 -06004633 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004634 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004635 " must be a multiple of this format's texel size (%" PRIu32 ").",
4636 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004637 }
4638
4639 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004640 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004641 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 -06004642 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004643 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4644 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004645 }
4646
4647 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4648 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004649 skip |=
4650 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004651 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004652 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4653 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004654 }
4655
4656 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4657 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4658 skip |= log_msg(
4659 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004660 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004661 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4662 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004663 }
4664
4665 // subresource aspectMask must have exactly 1 bit set
4666 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4667 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4668 if (aspect_mask_bits.count() != 1) {
4669 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 -06004670 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004671 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004672 }
4673
4674 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004675 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004676 skip |= log_msg(
4677 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004678 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004679 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4680 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004681 }
4682
4683 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004684 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004685 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004686
4687 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004688 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004689 skip |= log_msg(
4690 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004691 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004692 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4693 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004694 }
4695
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004696 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004697 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004698 skip |= log_msg(
4699 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004700 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004701 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4702 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004703 }
4704
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004705 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004706 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4707 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4708 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004709 skip |=
4710 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004711 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004712 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4713 "width & height (%d, %d)..",
4714 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004715 }
4716
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004717 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004718 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004719 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004720 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 -06004721 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004722 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004723 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004724 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004725 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004726
4727 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004728 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004729 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004730 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4731 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 -06004732 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004733 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004734 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004735 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004736 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004737 }
4738
4739 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004740 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004741 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4742 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 -06004743 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004744 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004745 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004746 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004747 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004748 }
4749
4750 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004751 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004752 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4753 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 -06004754 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004755 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004756 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004757 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004758 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004759 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004760 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004761 }
4762
4763 return skip;
4764}
4765
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004766static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004767 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004768 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004769 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004770
4771 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004772 VkExtent3D extent = pRegions[i].imageExtent;
4773 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004774
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004775 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4776 {
Dave Houlton51653902018-06-22 17:32:13 -06004777 skip |=
4778 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4779 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4780 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004781 }
4782
4783 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4784
4785 // 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 -06004786 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004787 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004788 if (image_extent.width % block_extent.width) {
4789 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4790 }
4791 if (image_extent.height % block_extent.height) {
4792 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4793 }
4794 if (image_extent.depth % block_extent.depth) {
4795 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4796 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004797 }
4798
Dave Houltonfc1a4052017-04-27 14:32:45 -06004799 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004800 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 -06004801 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004802 }
4803 }
4804
4805 return skip;
4806}
4807
Chris Forbese8ba09a2017-06-01 17:39:02 -07004808static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004809 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004810 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004811 bool skip = false;
4812
4813 VkDeviceSize buffer_size = buff_state->createInfo.size;
4814
4815 for (uint32_t i = 0; i < regionCount; i++) {
4816 VkExtent3D copy_extent = pRegions[i].imageExtent;
4817
4818 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4819 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004820 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004821
Dave Houltonf3229d52017-02-21 15:59:08 -07004822 // Handle special buffer packing rules for specific depth/stencil formats
4823 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004824 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004825 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4826 switch (image_state->createInfo.format) {
4827 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004828 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004829 break;
4830 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004831 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004832 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004833 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004834 case VK_FORMAT_D24_UNORM_S8_UINT:
4835 unit_size = 4;
4836 break;
4837 default:
4838 break;
4839 }
4840 }
4841
Tom Cooperb2550c72018-10-15 13:08:41 +01004842 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004843 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004844 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004845 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4846 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4847
4848 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4849 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4850 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004851 }
4852
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004853 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4854 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4855 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004856 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004857 } else {
4858 // Calculate buffer offset of final copied byte, + 1.
4859 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4860 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4861 max_buffer_offset *= unit_size; // convert to bytes
4862 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004863
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004864 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004865 skip |=
4866 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4867 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004868 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004869 }
4870 }
4871
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004872 return skip;
4873}
4874
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004875bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4876 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004877 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004878 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004879 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004880 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004881
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004882 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4883
4884 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004885 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004886
4887 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004888 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004889
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004890 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004891
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004892 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4893 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 -06004894 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004895 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004896 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004897 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004898 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004899 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004900 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004901 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004902
4903 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004904 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4905 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4906 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4907 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4908 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004909
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004910 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004911 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4912 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4913 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004914 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004915 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4916 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004917 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004918 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004919 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4920 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004921 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004922 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004923 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004924 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004925 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004926 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4927 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004928 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004929 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4930 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004931 skip |= VerifyImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004932 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4933 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004934 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004935 "vkCmdCopyImageToBuffer()",
4936 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004937 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4938 "vkCmdCopyImageToBuffer()", "imageSubresource",
4939 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4940 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4941 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4942 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004943 }
4944 return skip;
4945}
4946
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004947void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4948 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004949 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004950 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004951 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004952 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004953
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004954 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004955 for (uint32_t i = 0; i < regionCount; ++i) {
4956 SetImageLayout(device_data, cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004957 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004958 // Update bindings between buffer/image and cmd buffer
4959 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004960 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004961}
4962
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004963bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4964 VkImageLayout dstImageLayout, uint32_t regionCount,
4965 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004966 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004967 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004968 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004969 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004970
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004971 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4972
4973 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004974 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004975
4976 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004977 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004978 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004979 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4980 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 -06004981 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004982 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004983 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004984 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004985 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004986 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004987 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004988 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004989 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004990 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4991 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4992 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4993 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4994 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004995 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004996 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4997 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4998 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4999 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
5000 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005001 if (GetApiVersion(device_data) >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04005002 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06005003 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
5004 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04005005 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06005006 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06005007 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06005008 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005009 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07005010 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
5011 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005012 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07005013 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
5014 "imageSubresource", i);
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06005015 skip |= VerifyImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07005016 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
5017 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005018 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06005019 "vkCmdCopyBufferToImage()",
5020 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07005021 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
5022 "vkCmdCopyBufferToImage()", "imageSubresource",
5023 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
5024 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
5025 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
5026 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005027 }
5028 return skip;
5029}
5030
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005031void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5032 VkImageLayout dstImageLayout, uint32_t regionCount,
5033 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005034 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07005035 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005036 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005037 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005038
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005039 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005040 for (uint32_t i = 0; i < regionCount; ++i) {
5041 SetImageLayout(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005042 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005043 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005044 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005045}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005046
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005047bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5048 VkSubresourceLayout *pLayout) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07005049 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
5050 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07005051 bool skip = false;
5052 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5053
Dave Houlton1d960ff2018-01-19 12:17:05 -07005054 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005055 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5056 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5057 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005058 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 -06005059 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005060 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005061 }
5062
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005063 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005064 if (!image_entry) {
5065 return skip;
5066 }
5067
Dave Houlton1d960ff2018-01-19 12:17:05 -07005068 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005069 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005070 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5071 "VUID-vkGetImageSubresourceLayout-image-00996",
5072 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005073 }
5074
Dave Houlton1d960ff2018-01-19 12:17:05 -07005075 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005076 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005077 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5078 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5079 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5080 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005081 }
5082
Dave Houlton1d960ff2018-01-19 12:17:05 -07005083 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005084 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005085 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5086 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5087 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5088 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005089 }
5090
Dave Houlton1d960ff2018-01-19 12:17:05 -07005091 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005092 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005093 if (FormatIsMultiplane(img_format)) {
5094 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005095 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005096 if (FormatPlaneCount(img_format) > 2u) {
5097 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005098 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005099 }
5100 if (sub_aspect != (sub_aspect & allowed_flags)) {
5101 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 -06005102 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005103 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005104 ") must be a single-plane specifier flag.",
5105 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005106 }
5107 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005108 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005109 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005110 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005111 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005112 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005113 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005114 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005115 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005116 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 -06005117 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005118 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005119 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005120 }
5121 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005122
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005123 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005124 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5125 }
5126
Mike Weiblen672b58b2017-02-21 14:32:53 -07005127 return skip;
5128}