blob: 86651487219ded378cdf3f50bcdcbcd82e6109b9 [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 Lobodzinski8564e442019-03-07 12:49:41 -070052void CoreChecks::SetLayout(GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070053 auto it = pCB->imageLayoutMap.find(imgpair);
54 if (it != pCB->imageLayoutMap.end()) {
55 it->second.layout = layout;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070056 } else {
57 assert(imgpair.hasSubresource);
58 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -070059 if (!FindCmdBufLayout(pCB, imgpair.image, imgpair.subresource, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070060 node.initialLayout = layout;
61 }
Mark Lobodzinski8564e442019-03-07 12:49:41 -070062 SetLayout(pCB, imgpair, {node.initialLayout, layout});
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070063 }
64}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070065
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070066template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -070067void CoreChecks::SetLayout(OBJECT *pObject, VkImage image, VkImageSubresource range, const LAYOUT &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070068 ImageSubresourcePair imgpair = {image, true, range};
Mark Lobodzinski8564e442019-03-07 12:49:41 -070069 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
70 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
71 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
72 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -070073 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -070074 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
75 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
76 SetLayout(pObject, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -070077 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070078}
79
80template <class OBJECT, class LAYOUT>
Mark Lobodzinski8564e442019-03-07 12:49:41 -070081void CoreChecks::SetLayout(OBJECT *pObject, ImageSubresourcePair imgpair, const LAYOUT &layout, VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070082 if (imgpair.subresource.aspectMask & aspectMask) {
83 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski8564e442019-03-07 12:49:41 -070084 SetLayout(pObject, imgpair, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -070085 }
86}
87
Tony Barbourdf013b92017-01-25 12:53:48 -070088// Set the layout in supplied map
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -070089void CoreChecks::SetLayout(std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
90 ImageSubresourcePair imgpair, VkImageLayout layout) {
Dave Houltonb3f4b282018-02-22 16:25:16 -070091 auto it = imageLayoutMap.find(imgpair);
92 if (it != imageLayoutMap.end()) {
93 it->second.layout = layout; // Update
94 } else {
95 imageLayoutMap[imgpair].layout = layout; // Insert
96 }
Tony Barbourdf013b92017-01-25 12:53:48 -070097}
98
Mark Lobodzinski8564e442019-03-07 12:49:41 -070099bool CoreChecks::FindLayoutVerifyNode(GLOBAL_CB_NODE const *pCB, ImageSubresourcePair imgpair, IMAGE_CMD_BUF_LAYOUT_NODE &node,
100 const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700101 if (!(imgpair.subresource.aspectMask & aspectMask)) {
102 return false;
103 }
104 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
105 imgpair.subresource.aspectMask = aspectMask;
106 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
107 if (imgsubIt == pCB->imageLayoutMap.end()) {
108 return false;
109 }
110 if (node.layout != VK_IMAGE_LAYOUT_MAX_ENUM && node.layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200111 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 -0600112 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700113 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
114 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(node.layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700115 string_VkImageLayout(imgsubIt->second.layout));
116 }
117 if (node.initialLayout != VK_IMAGE_LAYOUT_MAX_ENUM && node.initialLayout != imgsubIt->second.initialLayout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200118 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 -0600119 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700120 "Cannot query for VkImage %s"
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700121 " layout when combined aspect mask %d has multiple initial layout types: %s and %s",
Lockee9aeebf2019-03-03 23:50:08 -0700122 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(node.initialLayout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700123 string_VkImageLayout(imgsubIt->second.initialLayout));
124 }
125 node = imgsubIt->second;
126 return true;
127}
128
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700129bool CoreChecks::FindLayoutVerifyLayout(ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700130 if (!(imgpair.subresource.aspectMask & aspectMask)) {
131 return false;
132 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700133 VkImageAspectFlags oldAspectMask = imgpair.subresource.aspectMask;
134 imgpair.subresource.aspectMask = aspectMask;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700135 auto imgsubIt = (*GetImageLayoutMap()).find(imgpair);
136 if (imgsubIt == (*GetImageLayoutMap()).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700137 return false;
138 }
139 if (layout != VK_IMAGE_LAYOUT_MAX_ENUM && layout != imgsubIt->second.layout) {
Petr Krausbc7f5442017-05-14 23:43:38 +0200140 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 -0600141 kVUID_Core_DrawState_InvalidLayout,
Lockee9aeebf2019-03-03 23:50:08 -0700142 "Cannot query for VkImage %s layout when combined aspect mask %d has multiple layout types: %s and %s",
143 report_data->FormatHandle(imgpair.image).c_str(), oldAspectMask, string_VkImageLayout(layout),
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700144 string_VkImageLayout(imgsubIt->second.layout));
145 }
146 layout = imgsubIt->second.layout;
147 return true;
148}
149
150// Find layout(s) on the command buffer level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700151bool CoreChecks::FindCmdBufLayout(GLOBAL_CB_NODE const *pCB, VkImage image, VkImageSubresource range,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700152 IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700153 ImageSubresourcePair imgpair = {image, true, range};
154 node = IMAGE_CMD_BUF_LAYOUT_NODE(VK_IMAGE_LAYOUT_MAX_ENUM, VK_IMAGE_LAYOUT_MAX_ENUM);
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700155 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_COLOR_BIT);
156 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_DEPTH_BIT);
157 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_STENCIL_BIT);
158 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700159 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700160 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
161 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
162 FindLayoutVerifyNode(pCB, imgpair, node, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700163 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700164 if (node.layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
165 imgpair = {image, false, VkImageSubresource()};
166 auto imgsubIt = pCB->imageLayoutMap.find(imgpair);
167 if (imgsubIt == pCB->imageLayoutMap.end()) return false;
168 // TODO: This is ostensibly a find function but it changes state here
169 node = imgsubIt->second;
170 }
171 return true;
172}
173
174// Find layout(s) on the global level
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700175bool CoreChecks::FindGlobalLayout(ImageSubresourcePair imgpair, VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700176 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700177 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
178 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
179 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
180 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700181 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700182 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
183 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
184 FindLayoutVerifyLayout(imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700185 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700186 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
187 imgpair = {imgpair.image, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700188 auto imgsubIt = (*GetImageLayoutMap()).find(imgpair);
189 if (imgsubIt == (*GetImageLayoutMap()).end()) return false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700190 layout = imgsubIt->second.layout;
191 }
192 return true;
193}
194
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700195bool CoreChecks::FindLayouts(VkImage image, std::vector<VkImageLayout> &layouts) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700196 auto sub_data = (*GetImageSubresourceMap()).find(image);
197 if (sub_data == (*GetImageSubresourceMap()).end()) return false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700198 auto image_state = GetImageState(image);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700199 if (!image_state) return false;
200 bool ignoreGlobal = false;
201 // TODO: Make this robust for >1 aspect mask. Now it will just say ignore potential errors in this case.
202 if (sub_data->second.size() >= (image_state->createInfo.arrayLayers * image_state->createInfo.mipLevels + 1)) {
203 ignoreGlobal = true;
204 }
205 for (auto imgsubpair : sub_data->second) {
206 if (ignoreGlobal && !imgsubpair.hasSubresource) continue;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700207 auto img_data = (*GetImageLayoutMap()).find(imgsubpair);
208 if (img_data != (*GetImageLayoutMap()).end()) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700209 layouts.push_back(img_data->second.layout);
210 }
211 }
212 return true;
213}
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700214
215bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
216 ImageSubresourcePair imgpair, VkImageLayout &layout, const VkImageAspectFlags aspectMask) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700217 if (!(imgpair.subresource.aspectMask & aspectMask)) {
218 return false;
219 }
220 imgpair.subresource.aspectMask = aspectMask;
221 auto imgsubIt = imageLayoutMap.find(imgpair);
222 if (imgsubIt == imageLayoutMap.end()) {
223 return false;
224 }
225 layout = imgsubIt->second.layout;
226 return true;
Tony Barboure0c5cc92017-02-08 13:53:39 -0700227}
Tony Barbourdf013b92017-01-25 12:53:48 -0700228
229// find layout in supplied map
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700230bool CoreChecks::FindLayout(const std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &imageLayoutMap,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700231 ImageSubresourcePair imgpair, VkImageLayout &layout) {
Tony Barbourdf013b92017-01-25 12:53:48 -0700232 layout = VK_IMAGE_LAYOUT_MAX_ENUM;
233 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_COLOR_BIT);
234 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_DEPTH_BIT);
235 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_STENCIL_BIT);
236 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700237 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700238 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
239 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
240 FindLayout(imageLayoutMap, imgpair, layout, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
241 }
242 // Image+subresource not found, look for image handle w/o subresource
Tony Barbourdf013b92017-01-25 12:53:48 -0700243 if (layout == VK_IMAGE_LAYOUT_MAX_ENUM) {
244 imgpair = {imgpair.image, false, VkImageSubresource()};
245 auto imgsubIt = imageLayoutMap.find(imgpair);
246 if (imgsubIt == imageLayoutMap.end()) return false;
247 layout = imgsubIt->second.layout;
248 }
249 return true;
250}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700251
252// Set the layout on the global level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700253void CoreChecks::SetGlobalLayout(ImageSubresourcePair imgpair, const VkImageLayout &layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700254 VkImage &image = imgpair.image;
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700255 auto &lmap = (*GetImageLayoutMap());
Dave Houltonb3f4b282018-02-22 16:25:16 -0700256 auto data = lmap.find(imgpair);
257 if (data != lmap.end()) {
258 data->second.layout = layout; // Update
259 } else {
260 lmap[imgpair].layout = layout; // Insert
261 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -0700262 auto &image_subresources = (*GetImageSubresourceMap())[image];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700263 auto subresource = std::find(image_subresources.begin(), image_subresources.end(), imgpair);
264 if (subresource == image_subresources.end()) {
265 image_subresources.push_back(imgpair);
266 }
267}
268
269// Set the layout on the cmdbuf level
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700270void CoreChecks::SetLayout(GLOBAL_CB_NODE *pCB, ImageSubresourcePair imgpair, const IMAGE_CMD_BUF_LAYOUT_NODE &node) {
Dave Houltonb3f4b282018-02-22 16:25:16 -0700271 auto it = pCB->imageLayoutMap.find(imgpair);
272 if (it != pCB->imageLayoutMap.end()) {
273 it->second = node; // Update
274 } else {
275 pCB->imageLayoutMap[imgpair] = node; // Insert
276 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700277}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600278// Set image layout for given VkImageSubresourceRange struct
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700279void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700280 VkImageSubresourceRange image_subresource_range, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600281 assert(image_state);
John Zulauf48a6a702017-12-22 17:14:54 -0700282 cb_node->image_layout_change_count++; // Change the version of this data to force revalidation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600283 for (uint32_t level_index = 0; level_index < image_subresource_range.levelCount; ++level_index) {
284 uint32_t level = image_subresource_range.baseMipLevel + level_index;
285 for (uint32_t layer_index = 0; layer_index < image_subresource_range.layerCount; layer_index++) {
286 uint32_t layer = image_subresource_range.baseArrayLayer + layer_index;
287 VkImageSubresource sub = {image_subresource_range.aspectMask, level, layer};
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700288 // TODO: If ImageView was created with depth or stencil, transition both layouts as the aspectMask is ignored and both
289 // are used. Verify that the extra implicit layout is OK for descriptor set layout validation
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600290 if (image_subresource_range.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600291 if (FormatIsDepthAndStencil(image_state->createInfo.format)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700292 sub.aspectMask |= (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
293 }
294 }
Tony-LunarG119b38a2018-12-18 09:49:16 -0700295 // For multiplane images, IMAGE_ASPECT_COLOR is an alias for all of the plane bits
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700296 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG119b38a2018-12-18 09:49:16 -0700297 if (FormatIsMultiplane(image_state->createInfo.format)) {
298 if (sub.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
299 sub.aspectMask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
300 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR;
301 if (FormatPlaneCount(image_state->createInfo.format) > 2) {
302 sub.aspectMask |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
303 }
304 }
305 }
306 }
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700307 SetLayout(cb_node, image_state->image, sub, layout);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700308 }
309 }
310}
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600311// Set image layout for given VkImageSubresourceLayers struct
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700312void CoreChecks::SetImageLayout(GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *image_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700313 VkImageSubresourceLayers image_subresource_layers, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600314 // Transfer VkImageSubresourceLayers into VkImageSubresourceRange struct
315 VkImageSubresourceRange image_subresource_range;
316 image_subresource_range.aspectMask = image_subresource_layers.aspectMask;
317 image_subresource_range.baseArrayLayer = image_subresource_layers.baseArrayLayer;
318 image_subresource_range.layerCount = image_subresource_layers.layerCount;
319 image_subresource_range.baseMipLevel = image_subresource_layers.mipLevel;
320 image_subresource_range.levelCount = 1;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700321 SetImageLayout(cb_node, image_state, image_subresource_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600322}
Dave Houltonddd65c52018-05-08 14:58:01 -0600323
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600324// Set image layout for all slices of an image view
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700325void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, IMAGE_VIEW_STATE *view_state, const VkImageLayout &layout) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600326 assert(view_state);
327
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700328 IMAGE_STATE *image_state = GetImageState(view_state->create_info.image);
Dave Houltonddd65c52018-05-08 14:58:01 -0600329 VkImageSubresourceRange sub_range = view_state->create_info.subresourceRange;
330
331 // When changing the layout of a 3D image subresource via a 2D or 2D_ARRRAY image view, all depth slices of
332 // the subresource mip level(s) are transitioned, ignoring any layers restriction in the subresource info.
333 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) && (view_state->create_info.viewType != VK_IMAGE_VIEW_TYPE_3D)) {
334 sub_range.baseArrayLayer = 0;
335 sub_range.layerCount = image_state->createInfo.extent.depth;
336 }
337
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700338 SetImageLayout(cb_node, image_state, sub_range, layout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -0600339}
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700340
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700341void CoreChecks::SetImageViewLayout(GLOBAL_CB_NODE *cb_node, VkImageView imageView, const VkImageLayout &layout) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700342 auto view_state = GetImageViewState(imageView);
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700343 SetImageViewLayout(cb_node, view_state, layout);
John Zulauf4ccf5c02018-09-21 11:46:18 -0600344}
345
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700346bool CoreChecks::ValidateRenderPassLayoutAgainstFramebufferImageUsage(RenderPassCreateVersion rp_version, VkImageLayout layout,
347 VkImage image, VkImageView image_view,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700348 VkFramebuffer framebuffer, VkRenderPass renderpass,
349 uint32_t attachment_index, const char *variable_name) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100350 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700351 auto image_state = GetImageState(image);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100352 const char *vuid;
353 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
354
355 if (!image_state) {
356 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
357 "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
Lockee9aeebf2019-03-03 23:50:08 -0700358 "Render Pass begin with renderpass %s uses framebuffer %s where pAttachments[%" PRIu32
359 "] = image view %s, which refers to an invalid image",
360 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(framebuffer).c_str(),
361 attachment_index, report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100362 return skip;
363 }
364
365 auto image_usage = image_state->createInfo.usage;
366
367 // Check for layouts that mismatch image usages in the framebuffer
368 if (layout == VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT)) {
369 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03094" : "VUID-vkCmdBeginRenderPass-initialLayout-00895";
370 skip |=
371 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700372 "Layout/usage mismatch for attachment %u in render pass %s"
373 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100374 " was not created with VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700375 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
376 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100377 }
378
379 if (layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL &&
380 !(image_usage & (VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT | VK_IMAGE_USAGE_SAMPLED_BIT))) {
381 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03097" : "VUID-vkCmdBeginRenderPass-initialLayout-00897";
382 skip |=
383 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700384 "Layout/usage mismatch for attachment %u in render pass %s"
385 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100386 " was not created with VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT or VK_IMAGE_USAGE_SAMPLED_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700387 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
388 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100389 }
390
391 if (layout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_SRC_BIT)) {
392 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03098" : "VUID-vkCmdBeginRenderPass-initialLayout-00898";
393 skip |=
394 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700395 "Layout/usage mismatch for attachment %u in render pass %s"
396 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100397 " was not created with VK_IMAGE_USAGE_TRANSFER_SRC_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700398 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
399 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100400 }
401
402 if (layout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && !(image_usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
403 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03099" : "VUID-vkCmdBeginRenderPass-initialLayout-00899";
404 skip |=
405 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
Lockee9aeebf2019-03-03 23:50:08 -0700406 "Layout/usage mismatch for attachment %u in render pass %s"
407 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100408 " was not created with VK_IMAGE_USAGE_TRANSFER_DST_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700409 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
410 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100411 }
412
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700413 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Tobias Hectorbbb12282018-10-22 15:17:59 +0100414 if ((layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL ||
415 layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL ||
416 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
417 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
418 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
419 vuid = use_rp2 ? "VUID-vkCmdBeginRenderPass2KHR-initialLayout-03096" : "VUID-vkCmdBeginRenderPass-initialLayout-01758";
Lockee9aeebf2019-03-03 23:50:08 -0700420 skip |= log_msg(
421 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image), vuid,
422 "Layout/usage mismatch for attachment %u in render pass %s"
423 " - the %s is %s but the image attached to framebuffer %s via image view %s"
424 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
425 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name, string_VkImageLayout(layout),
426 report_data->FormatHandle(renderpass).c_str(), report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100427 }
428 } else {
429 // The create render pass 2 extension requires maintenance 2 (the previous branch), so no vuid switch needed here.
430 if ((layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL ||
431 layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) &&
432 !(image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
433 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
434 HandleToUint64(image), "VUID-vkCmdBeginRenderPass-initialLayout-00896",
Lockee9aeebf2019-03-03 23:50:08 -0700435 "Layout/usage mismatch for attachment %u in render pass %s"
436 " - the %s is %s but the image attached to framebuffer %s via image view %s"
Tobias Hectorbbb12282018-10-22 15:17:59 +0100437 " was not created with VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT",
Lockee9aeebf2019-03-03 23:50:08 -0700438 attachment_index, report_data->FormatHandle(framebuffer).c_str(), variable_name,
439 string_VkImageLayout(layout), report_data->FormatHandle(renderpass).c_str(),
440 report_data->FormatHandle(image_view).c_str());
Tobias Hectorbbb12282018-10-22 15:17:59 +0100441 }
442 }
443 return skip;
444}
445
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700446bool CoreChecks::VerifyFramebufferAndRenderPassLayouts(RenderPassCreateVersion rp_version, GLOBAL_CB_NODE *pCB,
447 const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700448 const FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600449 bool skip = false;
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700450 auto const pRenderPassInfo = GetRenderPassState(pRenderPassBegin->renderPass)->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700451 auto const &framebufferInfo = framebuffer_state->createInfo;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100452
Mark Lobodzinski2e495882019-03-06 16:11:56 -0700453 auto render_pass = GetRenderPassState(pRenderPassBegin->renderPass)->renderPass;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100454 auto framebuffer = framebuffer_state->framebuffer;
455
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700456 if (pRenderPassInfo->attachmentCount != framebufferInfo.attachmentCount) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600457 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -0600458 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700459 "You cannot start a render pass using a framebuffer with a different number of attachments.");
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700460 }
461 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
462 const VkImageView &image_view = framebufferInfo.pAttachments[i];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700463 auto view_state = GetImageViewState(image_view);
John Zulauf8e308292018-09-21 11:34:37 -0600464
465 if (!view_state) {
Lockee9aeebf2019-03-03 23:50:08 -0700466 skip |=
467 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_RENDER_PASS_EXT,
468 HandleToUint64(pRenderPassBegin->renderPass), "VUID-VkRenderPassBeginInfo-framebuffer-parameter",
469 "vkCmdBeginRenderPass(): framebuffer %s pAttachments[%" PRIu32 "] = %s is not a valid VkImageView handle",
470 report_data->FormatHandle(framebuffer_state->framebuffer).c_str(), i,
471 report_data->FormatHandle(image_view).c_str());
John Zulauf8e308292018-09-21 11:34:37 -0600472 continue;
473 }
474
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700475 const VkImage &image = view_state->create_info.image;
476 const VkImageSubresourceRange &subRange = view_state->create_info.subresourceRange;
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700477 auto initial_layout = pRenderPassInfo->pAttachments[i].initialLayout;
Tobias Hectorbbb12282018-10-22 15:17:59 +0100478 auto final_layout = pRenderPassInfo->pAttachments[i].finalLayout;
479
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700480 // TODO: Do not iterate over every possibility - consolidate where possible
481 for (uint32_t j = 0; j < subRange.levelCount; j++) {
482 uint32_t level = subRange.baseMipLevel + j;
483 for (uint32_t k = 0; k < subRange.layerCount; k++) {
484 uint32_t layer = subRange.baseArrayLayer + k;
485 VkImageSubresource sub = {subRange.aspectMask, level, layer};
486 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700487 if (!FindCmdBufLayout(pCB, image, sub, node)) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700488 // Missing layouts will be added during state update
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700489 continue;
490 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700491 if (initial_layout != VK_IMAGE_LAYOUT_UNDEFINED && initial_layout != node.layout) {
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600492 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 -0600493 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -0700494 "You cannot start a render pass using attachment %u where the render pass initial layout is %s "
495 "and the previous known layout of the attachment is %s. The layouts must match, or the render "
496 "pass initial layout for the attachment must be VK_IMAGE_LAYOUT_UNDEFINED",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600497 i, string_VkImageLayout(initial_layout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700498 }
499 }
500 }
Tobias Hectorbbb12282018-10-22 15:17:59 +0100501
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700502 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, initial_layout, image, image_view, framebuffer,
503 render_pass, i, "initial layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100504
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700505 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, final_layout, image, image_view, framebuffer, render_pass,
506 i, "final layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100507 }
508
509 for (uint32_t j = 0; j < pRenderPassInfo->subpassCount; ++j) {
510 auto &subpass = pRenderPassInfo->pSubpasses[j];
511 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].inputAttachmentCount; ++k) {
512 auto &attachment_ref = subpass.pInputAttachments[k];
513 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
514 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700515 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100516
517 if (view_state) {
518 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700519 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
520 framebuffer, render_pass, attachment_ref.attachment,
521 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100522 }
523 }
524 }
525
526 for (uint32_t k = 0; k < pRenderPassInfo->pSubpasses[j].colorAttachmentCount; ++k) {
527 auto &attachment_ref = subpass.pColorAttachments[k];
528 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
529 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700530 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100531
532 if (view_state) {
533 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700534 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
535 framebuffer, render_pass, attachment_ref.attachment,
536 "color attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100537 if (subpass.pResolveAttachments) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700538 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
539 framebuffer, render_pass, attachment_ref.attachment,
540 "resolve attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100541 }
542 }
543 }
544 }
545
546 if (pRenderPassInfo->pSubpasses[j].pDepthStencilAttachment) {
547 auto &attachment_ref = *subpass.pDepthStencilAttachment;
548 if (attachment_ref.attachment != VK_ATTACHMENT_UNUSED) {
549 auto image_view = framebufferInfo.pAttachments[attachment_ref.attachment];
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700550 auto view_state = GetImageViewState(image_view);
Tobias Hectorbbb12282018-10-22 15:17:59 +0100551
552 if (view_state) {
553 auto image = view_state->create_info.image;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700554 ValidateRenderPassLayoutAgainstFramebufferImageUsage(rp_version, attachment_ref.layout, image, image_view,
555 framebuffer, render_pass, attachment_ref.attachment,
556 "input attachment layout");
Tobias Hectorbbb12282018-10-22 15:17:59 +0100557 }
558 }
559 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700560 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -0600561 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700562}
563
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700564void CoreChecks::TransitionAttachmentRefLayout(GLOBAL_CB_NODE *pCB, FRAMEBUFFER_STATE *pFramebuffer,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700565 const safe_VkAttachmentReference2KHR &ref) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700566 if (ref.attachment != VK_ATTACHMENT_UNUSED) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700567 auto image_view = GetAttachmentImageViewState(pFramebuffer, ref.attachment);
John Zulauf8e308292018-09-21 11:34:37 -0600568 if (image_view) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700569 SetImageViewLayout(pCB, image_view, ref.layout);
John Zulauf8e308292018-09-21 11:34:37 -0600570 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700571 }
572}
573
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700574void CoreChecks::TransitionSubpassLayouts(GLOBAL_CB_NODE *pCB, const RENDER_PASS_STATE *render_pass_state, const int subpass_index,
575 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700576 assert(render_pass_state);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700577
578 if (framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700579 auto const &subpass = render_pass_state->createInfo.pSubpasses[subpass_index];
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700580 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700581 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pInputAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700582 }
583 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700584 TransitionAttachmentRefLayout(pCB, framebuffer_state, subpass.pColorAttachments[j]);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700585 }
586 if (subpass.pDepthStencilAttachment) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700587 TransitionAttachmentRefLayout(pCB, framebuffer_state, *subpass.pDepthStencilAttachment);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700588 }
589 }
590}
591
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700592bool CoreChecks::ValidateImageAspectLayout(GLOBAL_CB_NODE const *pCB, const VkImageMemoryBarrier *mem_barrier, uint32_t level,
593 uint32_t layer, VkImageAspectFlags aspect) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700594 if (!(mem_barrier->subresourceRange.aspectMask & aspect)) {
595 return false;
596 }
597 VkImageSubresource sub = {aspect, level, layer};
598 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700599 if (!FindCmdBufLayout(pCB, mem_barrier->image, sub, node)) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700600 return false;
601 }
602 bool skip = false;
603 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
604 // TODO: Set memory invalid which is in mem_tracker currently
605 } else if (node.layout != mem_barrier->oldLayout) {
Lockee9aeebf2019-03-03 23:50:08 -0700606 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700607 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
608 HandleToUint64(pCB->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700609 "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 -0700610 report_data->FormatHandle(mem_barrier->image).c_str(), aspect, level, layer,
Lockee9aeebf2019-03-03 23:50:08 -0700611 string_VkImageLayout(mem_barrier->oldLayout), string_VkImageLayout(node.layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700612 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700613 return skip;
614}
615
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700616// Transition the layout state for renderpass attachments based on the BeginRenderPass() call. This includes:
617// 1. Transition into initialLayout state
618// 2. Transition from initialLayout to layout used in subpass 0
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700619void CoreChecks::TransitionBeginRenderPassLayouts(GLOBAL_CB_NODE *cb_state, const RENDER_PASS_STATE *render_pass_state,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700620 FRAMEBUFFER_STATE *framebuffer_state) {
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700621 // First transition into initialLayout
622 auto const rpci = render_pass_state->createInfo.ptr();
623 for (uint32_t i = 0; i < rpci->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -0700624 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -0600625 if (view_state) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700626 SetImageViewLayout(cb_state, view_state, rpci->pAttachments[i].initialLayout);
John Zulauf8e308292018-09-21 11:34:37 -0600627 }
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700628 }
629 // Now transition for first subpass (index 0)
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700630 TransitionSubpassLayouts(cb_state, render_pass_state, 0, framebuffer_state);
Tobin Ehlis0d4274b2017-02-17 15:17:04 -0700631}
632
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700633void CoreChecks::TransitionImageAspectLayout(GLOBAL_CB_NODE *pCB, const VkImageMemoryBarrier *mem_barrier, uint32_t level,
634 uint32_t layer, VkImageAspectFlags aspect_mask, VkImageAspectFlags aspect) {
Tony-LunarG0d27b302018-10-08 09:26:21 -0600635 if (!(aspect_mask & aspect)) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700636 return;
637 }
638 VkImageSubresource sub = {aspect, level, layer};
639 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700640 if (!FindCmdBufLayout(pCB, mem_barrier->image, sub, node)) {
John Zulauf48a6a702017-12-22 17:14:54 -0700641 pCB->image_layout_change_count++; // Change the version of this data to force revalidation
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700642 SetLayout(pCB, mem_barrier->image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(mem_barrier->oldLayout, mem_barrier->newLayout));
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700643 return;
644 }
645 if (mem_barrier->oldLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
646 // TODO: Set memory invalid
647 }
Mark Lobodzinski8564e442019-03-07 12:49:41 -0700648 SetLayout(pCB, mem_barrier->image, sub, mem_barrier->newLayout);
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -0700649}
650
Dave Houlton10b39482017-03-16 13:18:15 -0600651bool VerifyAspectsPresent(VkImageAspectFlags aspect_mask, VkFormat format) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600652 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != 0) {
Dave Houltone2fca552018-04-05 16:20:33 -0600653 if (!(FormatIsColor(format) || FormatIsMultiplane(format))) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600654 }
655 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600656 if (!FormatHasDepth(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600657 }
658 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0) {
Dave Houlton1d2022c2017-03-29 11:43:58 -0600659 if (!FormatHasStencil(format)) return false;
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600660 }
Dave Houltonb3f4b282018-02-22 16:25:16 -0700661 if (0 !=
662 (aspect_mask & (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR | VK_IMAGE_ASPECT_PLANE_2_BIT_KHR))) {
663 if (FormatPlaneCount(format) == 1) return false;
664 }
Dave Houlton4eaaf3a2017-03-14 11:31:20 -0600665 return true;
666}
667
Mike Weiblen62d08a32017-03-07 22:18:27 -0700668// Verify an ImageMemoryBarrier's old/new ImageLayouts are compatible with the Image's ImageUsageFlags.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700669bool CoreChecks::ValidateBarrierLayoutToImageUsage(const VkImageMemoryBarrier *img_barrier, bool new_not_old,
670 VkImageUsageFlags usage_flags, const char *func_name) {
Mike Weiblen62d08a32017-03-07 22:18:27 -0700671 bool skip = false;
672 const VkImageLayout layout = (new_not_old) ? img_barrier->newLayout : img_barrier->oldLayout;
Jeff Bolz6d3beaa2019-02-09 21:00:05 -0600673 const char *msg_code = kVUIDUndefined; // sentinel value meaning "no error"
Mike Weiblen62d08a32017-03-07 22:18:27 -0700674
675 switch (layout) {
676 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
677 if ((usage_flags & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600678 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01208";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700679 }
680 break;
681 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
682 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600683 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01209";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700684 }
685 break;
686 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
687 if ((usage_flags & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600688 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01210";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700689 }
690 break;
691 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
692 if ((usage_flags & (VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT)) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600693 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01211";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700694 }
695 break;
696 case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
697 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_SRC_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600698 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01212";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700699 }
700 break;
701 case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
702 if ((usage_flags & VK_IMAGE_USAGE_TRANSFER_DST_BIT) == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -0600703 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-01213";
Mike Weiblen62d08a32017-03-07 22:18:27 -0700704 }
705 break;
Dave Houlton142c4cb2018-10-17 15:04:41 -0600706 case VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV:
Jeff Bolz9af91c52018-09-01 21:53:57 -0500707 if ((usage_flags & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) == 0) {
708 msg_code = "VUID-VkImageMemoryBarrier-oldLayout-02088";
709 }
710 break;
Mike Weiblen62d08a32017-03-07 22:18:27 -0700711 default:
712 // Other VkImageLayout values do not have VUs defined in this context.
713 break;
714 }
715
Dave Houlton8e9f6542018-05-18 12:18:22 -0600716 if (msg_code != kVUIDUndefined) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -0600717 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 -0600718 HandleToUint64(img_barrier->image), msg_code,
Lockee9aeebf2019-03-03 23:50:08 -0700719 "%s: Image barrier 0x%p %sLayout=%s is not compatible with image %s usage flags 0x%" PRIx32 ".", func_name,
720 static_cast<const void *>(img_barrier), ((new_not_old) ? "new" : "old"), string_VkImageLayout(layout),
721 report_data->FormatHandle(img_barrier->image).c_str(), usage_flags);
Mike Weiblen62d08a32017-03-07 22:18:27 -0700722 }
723 return skip;
724}
725
John Zulauf463c51e2018-05-31 13:29:20 -0600726// Scoreboard for checking for duplicate and inconsistent barriers to images
727struct ImageBarrierScoreboardEntry {
728 uint32_t index;
729 // This is designed for temporary storage within the scope of the API call. If retained storage of the barriers is
730 // required, copies should be made and smart or unique pointers used in some other stucture (or this one refactored)
731 const VkImageMemoryBarrier *barrier;
732};
733using ImageBarrierScoreboardSubresMap = std::unordered_map<VkImageSubresourceRange, ImageBarrierScoreboardEntry>;
734using ImageBarrierScoreboardImageMap = std::unordered_map<VkImage, ImageBarrierScoreboardSubresMap>;
735
Mike Weiblen62d08a32017-03-07 22:18:27 -0700736// Verify image barriers are compatible with the images they reference.
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700737bool CoreChecks::ValidateBarriersToImages(GLOBAL_CB_NODE const *cb_state, uint32_t imageMemoryBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700738 const VkImageMemoryBarrier *pImageMemoryBarriers, const char *func_name) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700739 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700740
John Zulauf463c51e2018-05-31 13:29:20 -0600741 // Scoreboard for duplicate layout transition barriers within the list
742 // Pointers retained in the scoreboard only have the lifetime of *this* call (i.e. within the scope of the API call)
743 ImageBarrierScoreboardImageMap layout_transitions;
744
Mike Weiblen62d08a32017-03-07 22:18:27 -0700745 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
746 auto img_barrier = &pImageMemoryBarriers[i];
747 if (!img_barrier) continue;
748
John Zulauf463c51e2018-05-31 13:29:20 -0600749 // Update the scoreboard of layout transitions and check for barriers affecting the same image and subresource
750 // TODO: a higher precision could be gained by adapting the command_buffer image_layout_map logic looking for conflicts
751 // at a per sub-resource level
752 if (img_barrier->oldLayout != img_barrier->newLayout) {
753 ImageBarrierScoreboardEntry new_entry{i, img_barrier};
754 auto image_it = layout_transitions.find(img_barrier->image);
755 if (image_it != layout_transitions.end()) {
756 auto &subres_map = image_it->second;
757 auto subres_it = subres_map.find(img_barrier->subresourceRange);
758 if (subres_it != subres_map.end()) {
759 auto &entry = subres_it->second;
760 if ((entry.barrier->newLayout != img_barrier->oldLayout) &&
761 (img_barrier->oldLayout != VK_IMAGE_LAYOUT_UNDEFINED)) {
762 const VkImageSubresourceRange &range = img_barrier->subresourceRange;
763 skip = log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700764 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
765 HandleToUint64(cb_state->commandBuffer), "VUID-VkImageMemoryBarrier-oldLayout-01197",
Lockee9aeebf2019-03-03 23:50:08 -0700766 "%s: pImageMemoryBarrier[%u] conflicts with earlier entry pImageMemoryBarrier[%u]. Image %s"
John Zulauf463c51e2018-05-31 13:29:20 -0600767 " subresourceRange: aspectMask=%u baseMipLevel=%u levelCount=%u, baseArrayLayer=%u, layerCount=%u; "
768 "conflicting barrier transitions image layout from %s when earlier barrier transitioned to layout %s.",
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700769 func_name, i, entry.index, report_data->FormatHandle(img_barrier->image).c_str(), range.aspectMask,
Lockee9aeebf2019-03-03 23:50:08 -0700770 range.baseMipLevel, range.levelCount, range.baseArrayLayer, range.layerCount,
771 string_VkImageLayout(img_barrier->oldLayout), string_VkImageLayout(entry.barrier->newLayout));
John Zulauf463c51e2018-05-31 13:29:20 -0600772 }
773 entry = new_entry;
774 } else {
775 subres_map[img_barrier->subresourceRange] = new_entry;
776 }
777 } else {
778 layout_transitions[img_barrier->image][img_barrier->subresourceRange] = new_entry;
779 }
780 }
781
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700782 auto image_state = GetImageState(img_barrier->image);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600783 if (image_state) {
784 VkImageUsageFlags usage_flags = image_state->createInfo.usage;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700785 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, false, usage_flags, func_name);
786 skip |= ValidateBarrierLayoutToImageUsage(img_barrier, true, usage_flags, func_name);
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600787
788 // Make sure layout is able to be transitioned, currently only presented shared presentable images are locked
789 if (image_state->layout_locked) {
790 // TODO: Add unique id for error when available
Dave Houlton33c2d252017-06-09 17:08:32 -0600791 skip |= log_msg(
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700792 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
793 HandleToUint64(img_barrier->image), 0,
Lockee9aeebf2019-03-03 23:50:08 -0700794 "Attempting to transition shared presentable image %s"
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600795 " 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 -0700796 report_data->FormatHandle(img_barrier->image).c_str(), string_VkImageLayout(img_barrier->oldLayout),
797 string_VkImageLayout(img_barrier->newLayout));
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -0600798 }
799 }
800
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -0700801 VkImageCreateInfo *image_create_info = &(GetImageState(img_barrier->image)->createInfo);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600802 // For a Depth/Stencil image both aspects MUST be set
803 if (FormatIsDepthAndStencil(image_create_info->format)) {
804 auto const aspect_mask = img_barrier->subresourceRange.aspectMask;
805 auto const ds_mask = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
806 if ((aspect_mask & ds_mask) != (ds_mask)) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
808 HandleToUint64(img_barrier->image), "VUID-VkImageMemoryBarrier-image-01207",
Lockee9aeebf2019-03-03 23:50:08 -0700809 "%s: Image barrier 0x%p references image %s of format %s that must have the depth and stencil "
810 "aspects set, but its aspectMask is 0x%" PRIx32 ".",
811 func_name, static_cast<const void *>(img_barrier),
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700812 report_data->FormatHandle(img_barrier->image).c_str(), string_VkFormat(image_create_info->format),
813 aspect_mask);
Tobin Ehlis7ee9cbd2017-04-26 16:51:48 -0600814 }
815 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -0600816 uint32_t level_count = ResolveRemainingLevels(&img_barrier->subresourceRange, image_create_info->mipLevels);
817 uint32_t layer_count = ResolveRemainingLayers(&img_barrier->subresourceRange, image_create_info->arrayLayers);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700818
Mike Weiblen62d08a32017-03-07 22:18:27 -0700819 for (uint32_t j = 0; j < level_count; j++) {
820 uint32_t level = img_barrier->subresourceRange.baseMipLevel + j;
821 for (uint32_t k = 0; k < layer_count; k++) {
822 uint32_t layer = img_barrier->subresourceRange.baseArrayLayer + k;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700823 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_COLOR_BIT);
824 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_DEPTH_BIT);
825 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_STENCIL_BIT);
826 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -0700827 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -0700828 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
829 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
830 skip |= ValidateImageAspectLayout(cb_state, img_barrier, level, layer, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -0700831 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -0700832 }
833 }
834 }
835 return skip;
836}
837
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700838bool CoreChecks::IsReleaseOp(GLOBAL_CB_NODE *cb_state, VkImageMemoryBarrier const *barrier) {
John Zulauf1b33d5a2018-03-24 19:52:19 -0600839 if (!IsTransferOp(barrier)) return false;
Chris Forbes4de4b132017-08-21 11:27:08 -0700840
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700841 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700842 return pool && TempIsReleaseOp<VkImageMemoryBarrier, true>(pool, barrier);
Chris Forbes4de4b132017-08-21 11:27:08 -0700843}
844
John Zulauf6b4aae82018-05-09 13:03:36 -0600845template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700846bool CoreChecks::ValidateQFOTransferBarrierUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
847 uint32_t barrier_count, const Barrier *barriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600848 using BarrierRecord = QFOTransferBarrier<Barrier>;
849 bool skip = false;
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700850 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600851 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename BarrierRecord::Tag());
852 const char *barrier_name = BarrierRecord::BarrierName();
853 const char *handle_name = BarrierRecord::HandleName();
854 const char *transfer_type = nullptr;
855 for (uint32_t b = 0; b < barrier_count; b++) {
856 if (!IsTransferOp(&barriers[b])) continue;
857 const BarrierRecord *barrier_record = nullptr;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700858 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer */>(pool, &barriers[b]) &&
859 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600860 const auto found = barrier_sets.release.find(barriers[b]);
861 if (found != barrier_sets.release.cend()) {
862 barrier_record = &(*found);
863 transfer_type = "releasing";
864 }
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600865 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
866 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600867 const auto found = barrier_sets.acquire.find(barriers[b]);
868 if (found != barrier_sets.acquire.cend()) {
869 barrier_record = &(*found);
870 transfer_type = "acquiring";
871 }
872 }
873 if (barrier_record != nullptr) {
Lockee9aeebf2019-03-03 23:50:08 -0700874 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
875 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInCB(),
876 "%s: %s at index %" PRIu32 " %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
877 " to dstQueueFamilyIndex %" PRIu32 " duplicates existing barrier recorded in this command buffer.",
878 func_name, barrier_name, b, transfer_type, handle_name,
879 report_data->FormatHandle(barrier_record->handle).c_str(), barrier_record->srcQueueFamilyIndex,
880 barrier_record->dstQueueFamilyIndex);
John Zulauf6b4aae82018-05-09 13:03:36 -0600881 }
882 }
883 return skip;
884}
885
886template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700887void CoreChecks::RecordQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t barrier_count,
888 const Barrier *barriers) {
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -0700889 auto pool = GetCommandPoolNode(cb_state->createInfo.commandPool);
John Zulauf6b4aae82018-05-09 13:03:36 -0600890 auto &barrier_sets = GetQFOBarrierSets(cb_state, typename QFOTransferBarrier<Barrier>::Tag());
891 for (uint32_t b = 0; b < barrier_count; b++) {
892 if (!IsTransferOp(&barriers[b])) continue;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700893 if (TempIsReleaseOp<Barrier, true /* Assume IsTransfer*/>(pool, &barriers[b]) &&
894 !IsSpecial(barriers[b].dstQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600895 barrier_sets.release.emplace(barriers[b]);
Shannon McPhersoned2f0092018-08-30 17:18:04 -0600896 } else if (IsAcquireOp<Barrier, true /*Assume IsTransfer */>(pool, &barriers[b]) &&
897 !IsSpecial(barriers[b].srcQueueFamilyIndex)) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600898 barrier_sets.acquire.emplace(barriers[b]);
899 }
900 }
901}
902
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700903bool CoreChecks::ValidateBarriersQFOTransferUniqueness(layer_data *device_data, const char *func_name, GLOBAL_CB_NODE *cb_state,
904 uint32_t bufferBarrierCount, const VkBufferMemoryBarrier *pBufferMemBarriers,
905 uint32_t imageMemBarrierCount,
906 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600907 bool skip = false;
908 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, bufferBarrierCount, pBufferMemBarriers);
909 skip |= ValidateQFOTransferBarrierUniqueness(device_data, func_name, cb_state, imageMemBarrierCount, pImageMemBarriers);
910 return skip;
911}
912
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700913void CoreChecks::RecordBarriersQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state, uint32_t bufferBarrierCount,
914 const VkBufferMemoryBarrier *pBufferMemBarriers, uint32_t imageMemBarrierCount,
915 const VkImageMemoryBarrier *pImageMemBarriers) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600916 RecordQFOTransferBarriers(device_data, cb_state, bufferBarrierCount, pBufferMemBarriers);
917 RecordQFOTransferBarriers(device_data, cb_state, imageMemBarrierCount, pImageMemBarriers);
918}
919
920template <typename BarrierRecord, typename Scoreboard>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700921bool CoreChecks::ValidateAndUpdateQFOScoreboard(const debug_report_data *report_data, const GLOBAL_CB_NODE *cb_state,
922 const char *operation, const BarrierRecord &barrier, Scoreboard *scoreboard) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600923 // Record to the scoreboard or report that we have a duplication
924 bool skip = false;
925 auto inserted = scoreboard->insert(std::make_pair(barrier, cb_state));
926 if (!inserted.second && inserted.first->second != cb_state) {
927 // 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 -0700928 skip = log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
929 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOInSubmit(),
930 "%s: %s %s queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32 " to dstQueueFamilyIndex %" PRIu32
931 " duplicates existing barrier submitted in this batch from command buffer %s.",
932 "vkQueueSubmit()", BarrierRecord::BarrierName(), operation, BarrierRecord::HandleName(),
933 report_data->FormatHandle(barrier.handle).c_str(), barrier.srcQueueFamilyIndex, barrier.dstQueueFamilyIndex,
934 report_data->FormatHandle(inserted.first->second).c_str());
John Zulauf6b4aae82018-05-09 13:03:36 -0600935 }
936 return skip;
937}
938
939template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700940bool CoreChecks::ValidateQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
941 QFOTransferCBScoreboards<Barrier> *scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600942 using BarrierRecord = QFOTransferBarrier<Barrier>;
943 using TypeTag = typename BarrierRecord::Tag;
944 bool skip = false;
John Zulauf6b4aae82018-05-09 13:03:36 -0600945 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -0700946 const GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -0600947 const char *barrier_name = BarrierRecord::BarrierName();
948 const char *handle_name = BarrierRecord::HandleName();
949 // No release should have an extant duplicate (WARNING)
950 for (const auto &release : cb_barriers.release) {
951 // Check the global pending release barriers
952 const auto set_it = global_release_barriers.find(release.handle);
953 if (set_it != global_release_barriers.cend()) {
954 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
955 const auto found = set_for_handle.find(release);
956 if (found != set_for_handle.cend()) {
957 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
958 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgDuplicateQFOSubmitted(),
Lockee9aeebf2019-03-03 23:50:08 -0700959 "%s: %s releasing queue ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
John Zulauf6b4aae82018-05-09 13:03:36 -0600960 " to dstQueueFamilyIndex %" PRIu32
961 " duplicates existing barrier queued for execution, without intervening acquire operation.",
Lockee9aeebf2019-03-03 23:50:08 -0700962 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(found->handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600963 found->srcQueueFamilyIndex, found->dstQueueFamilyIndex);
964 }
965 }
966 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "releasing", release, &scoreboards->release);
967 }
968 // Each acquire must have a matching release (ERROR)
969 for (const auto &acquire : cb_barriers.acquire) {
970 const auto set_it = global_release_barriers.find(acquire.handle);
971 bool matching_release_found = false;
972 if (set_it != global_release_barriers.cend()) {
973 const QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
974 matching_release_found = set_for_handle.find(acquire) != set_for_handle.cend();
975 }
976 if (!matching_release_found) {
977 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
978 HandleToUint64(cb_state->commandBuffer), BarrierRecord::ErrMsgMissingQFOReleaseInSubmit(),
Lockee9aeebf2019-03-03 23:50:08 -0700979 "%s: in submitted command buffer %s acquiring ownership of %s (%s), from srcQueueFamilyIndex %" PRIu32
980 " to dstQueueFamilyIndex %" PRIu32 " has no matching release barrier queued for execution.",
981 "vkQueueSubmit()", barrier_name, handle_name, report_data->FormatHandle(acquire.handle).c_str(),
John Zulauf6b4aae82018-05-09 13:03:36 -0600982 acquire.srcQueueFamilyIndex, acquire.dstQueueFamilyIndex);
983 }
984 skip |= ValidateAndUpdateQFOScoreboard(report_data, cb_state, "acquiring", acquire, &scoreboards->acquire);
985 }
986 return skip;
987}
988
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700989bool CoreChecks::ValidateQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state,
990 QFOTransferCBScoreboards<VkImageMemoryBarrier> *qfo_image_scoreboards,
991 QFOTransferCBScoreboards<VkBufferMemoryBarrier> *qfo_buffer_scoreboards) {
John Zulauf6b4aae82018-05-09 13:03:36 -0600992 bool skip = false;
993 skip |= ValidateQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state, qfo_image_scoreboards);
994 skip |= ValidateQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state, qfo_buffer_scoreboards);
995 return skip;
996}
997
998template <typename Barrier>
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -0700999void CoreChecks::RecordQueuedQFOTransferBarriers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001000 using BarrierRecord = QFOTransferBarrier<Barrier>;
1001 using TypeTag = typename BarrierRecord::Tag;
1002 const auto &cb_barriers = GetQFOBarrierSets(cb_state, TypeTag());
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001003 GlobalQFOTransferBarrierMap<Barrier> &global_release_barriers = GetGlobalQFOReleaseBarrierMap(TypeTag());
John Zulauf6b4aae82018-05-09 13:03:36 -06001004
1005 // Add release barriers from this submit to the global map
1006 for (const auto &release : cb_barriers.release) {
1007 // the global barrier list is mapped by resource handle to allow cleanup on resource destruction
1008 // NOTE: We're using [] because creation of a Set is a needed side effect for new handles
1009 global_release_barriers[release.handle].insert(release);
1010 }
1011
1012 // Erase acquired barriers from this submit from the global map -- essentially marking releases as consumed
1013 for (const auto &acquire : cb_barriers.acquire) {
1014 // NOTE: We're not using [] because we don't want to create entries for missing releases
1015 auto set_it = global_release_barriers.find(acquire.handle);
1016 if (set_it != global_release_barriers.end()) {
1017 QFOTransferBarrierSet<Barrier> &set_for_handle = set_it->second;
1018 set_for_handle.erase(acquire);
1019 if (set_for_handle.size() == 0) { // Clean up empty sets
1020 global_release_barriers.erase(set_it);
1021 }
1022 }
1023 }
1024}
1025
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001026void CoreChecks::RecordQueuedQFOTransfers(layer_data *device_data, GLOBAL_CB_NODE *cb_state) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001027 RecordQueuedQFOTransferBarriers<VkImageMemoryBarrier>(device_data, cb_state);
1028 RecordQueuedQFOTransferBarriers<VkBufferMemoryBarrier>(device_data, cb_state);
1029}
1030
John Zulauf6b4aae82018-05-09 13:03:36 -06001031// Avoid making the template globally visible by exporting the one instance of it we need.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001032void CoreChecks::EraseQFOImageRelaseBarriers(layer_data *device_data, const VkImage &image) {
John Zulauf6b4aae82018-05-09 13:03:36 -06001033 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
1034}
1035
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001036void CoreChecks::TransitionImageLayouts(GLOBAL_CB_NODE *cb_state, uint32_t memBarrierCount,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001037 const VkImageMemoryBarrier *pImgMemBarriers) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001038 for (uint32_t i = 0; i < memBarrierCount; ++i) {
1039 auto mem_barrier = &pImgMemBarriers[i];
1040 if (!mem_barrier) continue;
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001041
Chris Forbes4de4b132017-08-21 11:27:08 -07001042 // For ownership transfers, the barrier is specified twice; as a release
1043 // operation on the yielding queue family, and as an acquire operation
1044 // on the acquiring queue family. This barrier may also include a layout
1045 // transition, which occurs 'between' the two operations. For validation
1046 // purposes it doesn't seem important which side performs the layout
1047 // transition, but it must not be performed twice. We'll arbitrarily
1048 // choose to perform it as part of the acquire operation.
Mark Lobodzinski8deebf12019-03-07 11:38:38 -07001049 if (IsReleaseOp(cb_state, mem_barrier)) {
Chris Forbes4de4b132017-08-21 11:27:08 -07001050 continue;
1051 }
1052
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001053 VkImageCreateInfo *image_create_info = &(GetImageState(mem_barrier->image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001054 uint32_t level_count = ResolveRemainingLevels(&mem_barrier->subresourceRange, image_create_info->mipLevels);
1055 uint32_t layer_count = ResolveRemainingLayers(&mem_barrier->subresourceRange, image_create_info->arrayLayers);
1056
Dave Houltonb3f4b282018-02-22 16:25:16 -07001057 // Special case for 3D images with VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR flag bit, where <extent.depth> and
1058 // <arrayLayers> can potentially alias. When recording layout for the entire image, pre-emptively record layouts
1059 // for all (potential) layer sub_resources.
1060 if ((0 != (image_create_info->flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) &&
1061 (mem_barrier->subresourceRange.baseArrayLayer == 0) && (layer_count == 1)) {
1062 layer_count = image_create_info->extent.depth; // Treat each depth slice as a layer subresource
1063 }
1064
Tony-LunarG0d27b302018-10-08 09:26:21 -06001065 // For multiplanar formats, IMAGE_ASPECT_COLOR is equivalent to adding the aspect of the individual planes
1066 VkImageAspectFlags aspect_mask = mem_barrier->subresourceRange.aspectMask;
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001067 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Tony-LunarG0d27b302018-10-08 09:26:21 -06001068 if (FormatIsMultiplane(image_create_info->format)) {
1069 if (aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) {
1070 aspect_mask &= ~VK_IMAGE_ASPECT_COLOR_BIT;
1071 aspect_mask |= (VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT);
1072 if (FormatPlaneCount(image_create_info->format) > 2) {
1073 aspect_mask |= VK_IMAGE_ASPECT_PLANE_2_BIT;
1074 }
1075 }
1076 }
1077 }
1078
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001079 for (uint32_t j = 0; j < level_count; j++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001080 uint32_t level = mem_barrier->subresourceRange.baseMipLevel + j;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001081 for (uint32_t k = 0; k < layer_count; k++) {
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001082 uint32_t layer = mem_barrier->subresourceRange.baseArrayLayer + k;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001083 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_COLOR_BIT);
1084 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_DEPTH_BIT);
1085 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_STENCIL_BIT);
1086 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_METADATA_BIT);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001087 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001088 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_0_BIT_KHR);
1089 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
1090 TransitionImageAspectLayout(cb_state, mem_barrier, level, layer, aspect_mask, VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
Dave Houltonb3f4b282018-02-22 16:25:16 -07001091 }
Mark Lobodzinski6b6c50a2017-02-27 12:56:14 -07001092 }
1093 }
1094 }
1095}
1096
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001097bool CoreChecks::VerifyImageLayout(GLOBAL_CB_NODE const *cb_node, IMAGE_STATE *image_state, VkImageSubresourceLayers subLayers,
1098 VkImageLayout explicit_layout, VkImageLayout optimal_layout, const char *caller,
1099 const char *layout_invalid_msg_code, const char *layout_mismatch_msg_code, bool *error) {
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001100 const auto image = image_state->image;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001101 bool skip = false;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001102
1103 for (uint32_t i = 0; i < subLayers.layerCount; ++i) {
1104 uint32_t layer = i + subLayers.baseArrayLayer;
1105 VkImageSubresource sub = {subLayers.aspectMask, subLayers.mipLevel, layer};
1106 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001107 if (FindCmdBufLayout(cb_node, image, sub, node)) {
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001108 if (node.layout != explicit_layout) {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001109 *error = true;
Cort Stratton7df30962018-05-17 19:45:57 -07001110 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
1111 HandleToUint64(cb_node->commandBuffer), layout_mismatch_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001112 "%s: Cannot use image %s (layer=%u mip=%u) with specific layout %s that doesn't match the actual "
1113 "current layout %s.",
1114 caller, report_data->FormatHandle(image).c_str(), layer, subLayers.mipLevel,
1115 string_VkImageLayout(explicit_layout), string_VkImageLayout(node.layout));
Tobin Ehlise35b66a2017-03-15 12:18:31 -06001116 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001117 }
1118 }
Tobin Ehlis2d85ec62017-03-14 15:38:48 -06001119 // If optimal_layout is not UNDEFINED, check that layout matches optimal for this case
1120 if ((VK_IMAGE_LAYOUT_UNDEFINED != optimal_layout) && (explicit_layout != optimal_layout)) {
1121 if (VK_IMAGE_LAYOUT_GENERAL == explicit_layout) {
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001122 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1123 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001124 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001125 VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, HandleToUint64(cb_node->commandBuffer),
Dave Houlton51653902018-06-22 17:32:13 -06001126 kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07001127 "%s: For optimal performance image %s layout should be %s instead of GENERAL.", caller,
1128 report_data->FormatHandle(image).c_str(), string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001129 }
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001130 } else if (GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001131 if (image_state->shared_presentable) {
1132 if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR != explicit_layout) {
Cort Stratton7df30962018-05-17 19:45:57 -07001133 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1134 layout_invalid_msg_code,
1135 "Layout for shared presentable image is %s but must be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1136 string_VkImageLayout(optimal_layout));
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001137 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001138 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001139 } else {
Tobin Ehlisc8266452017-04-07 12:20:30 -06001140 *error = true;
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001141 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 -07001142 HandleToUint64(cb_node->commandBuffer), layout_invalid_msg_code,
Lockee9aeebf2019-03-03 23:50:08 -07001143 "%s: Layout for image %s is %s but can only be %s or VK_IMAGE_LAYOUT_GENERAL.", caller,
1144 report_data->FormatHandle(image).c_str(), string_VkImageLayout(explicit_layout),
1145 string_VkImageLayout(optimal_layout));
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001146 }
1147 }
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001148 return skip;
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001149}
1150
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001151void CoreChecks::TransitionFinalSubpassLayouts(GLOBAL_CB_NODE *pCB, const VkRenderPassBeginInfo *pRenderPassBegin,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001152 FRAMEBUFFER_STATE *framebuffer_state) {
Mark Lobodzinski2e495882019-03-06 16:11:56 -07001153 auto renderPass = GetRenderPassState(pRenderPassBegin->renderPass);
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001154 if (!renderPass) return;
1155
Tobias Hectorbbb12282018-10-22 15:17:59 +01001156 const VkRenderPassCreateInfo2KHR *pRenderPassInfo = renderPass->createInfo.ptr();
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001157 if (framebuffer_state) {
1158 for (uint32_t i = 0; i < pRenderPassInfo->attachmentCount; ++i) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07001159 auto view_state = GetAttachmentImageViewState(framebuffer_state, i);
John Zulauf8e308292018-09-21 11:34:37 -06001160 if (view_state) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001161 SetImageViewLayout(pCB, view_state, pRenderPassInfo->pAttachments[i].finalLayout);
John Zulauf8e308292018-09-21 11:34:37 -06001162 }
Mark Lobodzinski3c0f6362017-02-01 13:35:48 -07001163 }
1164 }
1165}
Dave Houltone19e20d2018-02-02 16:32:41 -07001166
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001167#ifdef VK_USE_PLATFORM_ANDROID_KHR
1168// Android-specific validation that uses types defined only with VK_USE_PLATFORM_ANDROID_KHR
1169// This could also move into a seperate core_validation_android.cpp file... ?
1170
1171//
1172// AHB-specific validation within non-AHB APIs
1173//
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001174bool CoreChecks::ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1175 const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001176 bool skip = false;
1177
1178 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
1179 if (ext_fmt_android) {
Dave Houltond9611312018-11-19 17:03:36 -07001180 if (0 != ext_fmt_android->externalFormat) {
1181 if (VK_FORMAT_UNDEFINED != create_info->format) {
1182 skip |=
1183 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1184 "VUID-VkImageCreateInfo-pNext-01974",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001185 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with non-zero "
Dave Houltond9611312018-11-19 17:03:36 -07001186 "externalFormat, but the VkImageCreateInfo's format is not VK_FORMAT_UNDEFINED.");
1187 }
1188
1189 if (0 != (VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT & create_info->flags)) {
1190 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1191 "VUID-VkImageCreateInfo-pNext-02396",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001192 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001193 "non-zero externalFormat, but flags include VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
1194 }
1195
1196 if (0 != (~VK_IMAGE_USAGE_SAMPLED_BIT & create_info->usage)) {
1197 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1198 "VUID-VkImageCreateInfo-pNext-02397",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001199 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001200 "non-zero externalFormat, but usage includes bits other than VK_IMAGE_USAGE_SAMPLED_BIT.");
1201 }
1202
1203 if (VK_IMAGE_TILING_OPTIMAL != create_info->tiling) {
1204 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1205 "VUID-VkImageCreateInfo-pNext-02398",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001206 "vkCreateImage(): VkImageCreateInfo struct has a chained VkExternalFormatANDROID struct with "
Dave Houltond9611312018-11-19 17:03:36 -07001207 "non-zero externalFormat, but layout is not VK_IMAGE_TILING_OPTIMAL.");
1208 }
1209 }
1210
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001211 auto ahb_formats = GetAHBExternalFormatsSet();
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001212 if ((0 != ext_fmt_android->externalFormat) && (0 == ahb_formats->count(ext_fmt_android->externalFormat))) {
1213 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1214 "VUID-VkExternalFormatANDROID-externalFormat-01894",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001215 "vkCreateImage(): Chained VkExternalFormatANDROID struct contains a non-zero externalFormat which has "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001216 "not been previously retrieved by vkGetAndroidHardwareBufferPropertiesANDROID().");
1217 }
1218 }
1219
Dave Houltond9611312018-11-19 17:03:36 -07001220 if ((nullptr == ext_fmt_android) || (0 == ext_fmt_android->externalFormat)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001221 if (VK_FORMAT_UNDEFINED == create_info->format) {
1222 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1223 "VUID-VkImageCreateInfo-pNext-01975",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001224 "vkCreateImage(): VkImageCreateInfo struct's format is VK_FORMAT_UNDEFINED, but either does not have a "
Dave Houltond9611312018-11-19 17:03:36 -07001225 "chained VkExternalFormatANDROID struct or the struct exists but has an externalFormat of 0.");
1226 }
1227 }
1228
1229 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1230 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1231 if (create_info->imageType != VK_IMAGE_TYPE_2D) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001232 skip |=
1233 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1234 "VUID-VkImageCreateInfo-pNext-02393",
1235 "vkCreateImage(): VkImageCreateInfo struct with imageType %s has chained VkExternalMemoryImageCreateInfo "
1236 "struct with handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID.",
1237 string_VkImageType(create_info->imageType));
Dave Houltond9611312018-11-19 17:03:36 -07001238 }
1239
1240 if ((create_info->mipLevels != 1) && (create_info->mipLevels != FullMipChainLevels(create_info->extent))) {
1241 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1242 "VUID-VkImageCreateInfo-pNext-02394",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001243 "vkCreateImage(): VkImageCreateInfo struct with chained VkExternalMemoryImageCreateInfo struct of "
Dave Houltond9611312018-11-19 17:03:36 -07001244 "handleType VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID "
1245 "specifies mipLevels = %" PRId32 " (full chain mipLevels are %" PRId32 ").",
1246 create_info->mipLevels, FullMipChainLevels(create_info->extent));
1247 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001248 }
1249
1250 return skip;
1251}
1252
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001253void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001254 const VkExternalMemoryImageCreateInfo *emici = lvl_find_in_chain<VkExternalMemoryImageCreateInfo>(create_info->pNext);
1255 if (emici && (emici->handleTypes & VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID)) {
1256 is_node->imported_ahb = true;
1257 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001258 const VkExternalFormatANDROID *ext_fmt_android = lvl_find_in_chain<VkExternalFormatANDROID>(create_info->pNext);
egdaniel1f4d2a42019-02-04 10:25:38 -05001259 if (ext_fmt_android && (0 != ext_fmt_android->externalFormat)) {
Dave Houltond3e046d2018-11-28 13:08:09 -07001260 is_node->has_ahb_format = true;
1261 is_node->ahb_format = ext_fmt_android->externalFormat;
1262 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001263}
1264
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001265bool CoreChecks::ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001266 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001267 IMAGE_STATE *image_state = GetImageState(create_info->image);
Dave Houltond3e046d2018-11-28 13:08:09 -07001268
1269 if (image_state->has_ahb_format) {
Dave Houltond9611312018-11-19 17:03:36 -07001270 if (VK_FORMAT_UNDEFINED != create_info->format) {
1271 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1272 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02399",
1273 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1274 "format member is %s.",
1275 string_VkFormat(create_info->format));
1276 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001277
Dave Houltond9611312018-11-19 17:03:36 -07001278 // Chain must include a compatible ycbcr conversion
1279 bool conv_found = false;
1280 uint64_t external_format = 0;
1281 const VkSamplerYcbcrConversionInfo *ycbcr_conv_info = lvl_find_in_chain<VkSamplerYcbcrConversionInfo>(create_info->pNext);
1282 if (ycbcr_conv_info != nullptr) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001283 VkSamplerYcbcrConversion conv_handle = ycbcr_conv_info->conversion;
Mark Lobodzinskieb8654d2019-03-07 11:14:47 -07001284 auto fmap = GetYcbcrConversionFormatMap();
Dave Houltond9611312018-11-19 17:03:36 -07001285 if (fmap->find(conv_handle) != fmap->end()) {
1286 conv_found = true;
1287 external_format = fmap->at(conv_handle);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001288 }
Dave Houltond9611312018-11-19 17:03:36 -07001289 }
Dave Houltond3e046d2018-11-28 13:08:09 -07001290 if ((!conv_found) || (external_format != image_state->ahb_format)) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001291 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 -07001292 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02400",
1293 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1294 "without a chained VkSamplerYcbcrConversionInfo struct with the same external format.");
1295 }
1296
1297 // Errors in create_info swizzles
1298 if ((create_info->components.r != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1299 (create_info->components.g != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1300 (create_info->components.b != VK_COMPONENT_SWIZZLE_IDENTITY) ||
1301 (create_info->components.a != VK_COMPONENT_SWIZZLE_IDENTITY)) {
1302 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
1303 HandleToUint64(create_info->image), "VUID-VkImageViewCreateInfo-image-02401",
1304 "vkCreateImageView(): VkImageViewCreateInfo struct has a chained VkExternalFormatANDROID struct, but "
1305 "includes one or more non-identity component swizzles.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001306 }
1307 }
Dave Houltond9611312018-11-19 17:03:36 -07001308
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001309 return skip;
1310}
1311
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001312bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001313 bool skip = false;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001314
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001315 IMAGE_STATE *image_state = GetImageState(image);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001316 if (image_state->imported_ahb && (0 == image_state->GetBoundMemory().size())) {
1317 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
1318 "VUID-vkGetImageSubresourceLayout-image-01895",
Graeme Leese79b60cb2018-11-28 11:51:20 +00001319 "vkGetImageSubresourceLayout(): Attempt to query layout from an image created with "
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001320 "VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID handleType which has not yet been "
1321 "bound to memory.");
1322 }
1323 return skip;
1324}
1325
1326#else
1327
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001328bool CoreChecks::ValidateCreateImageANDROID(layer_data *device_data, const debug_report_data *report_data,
1329 const VkImageCreateInfo *create_info) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001330 return false;
1331}
1332
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001333void CoreChecks::RecordCreateImageANDROID(const VkImageCreateInfo *create_info, IMAGE_STATE *is_node) {}
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001334
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001335bool CoreChecks::ValidateCreateImageViewANDROID(layer_data *device_data, const VkImageViewCreateInfo *create_info) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001336
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001337bool CoreChecks::ValidateGetImageSubresourceLayoutANDROID(layer_data *device_data, const VkImage image) { return false; }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001338
1339#endif // VK_USE_PLATFORM_ANDROID_KHR
1340
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001341bool CoreChecks::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1342 const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
1343 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001344 bool skip = false;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001345
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001346 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001347 skip |= ValidateCreateImageANDROID(device_data, report_data, pCreateInfo);
1348 } else { // These checks are omitted or replaced when Android HW Buffer extension is active
1349 if (pCreateInfo->format == VK_FORMAT_UNDEFINED) {
1350 return log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1351 "VUID-VkImageCreateInfo-format-00943",
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001352 "vkCreateImage(): VkFormat for image must not be VK_FORMAT_UNDEFINED.");
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001353 }
Jeremy Hayes96dcd812017-03-14 14:04:19 -06001354 }
1355
Dave Houlton130c0212018-01-29 13:39:56 -07001356 if ((pCreateInfo->flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT) && (VK_IMAGE_TYPE_2D != pCreateInfo->imageType)) {
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001357 skip |= log_msg(
1358 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1359 "VUID-VkImageCreateInfo-flags-00949",
1360 "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 -07001361 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001362
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001363 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Dave Houlton130c0212018-01-29 13:39:56 -07001364 VkImageUsageFlags attach_flags = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT |
1365 VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
1366 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.width > device_limits->maxFramebufferWidth)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001367 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 +00001368 "VUID-VkImageCreateInfo-usage-00964",
1369 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image width exceeds device "
1370 "maxFramebufferWidth.");
Dave Houlton130c0212018-01-29 13:39:56 -07001371 }
1372
1373 if ((pCreateInfo->usage & attach_flags) && (pCreateInfo->extent.height > device_limits->maxFramebufferHeight)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001374 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 +00001375 "VUID-VkImageCreateInfo-usage-00965",
1376 "vkCreateImage(): Image usage flags include a frame buffer attachment bit and image height exceeds device "
1377 "maxFramebufferHeight");
Dave Houlton130c0212018-01-29 13:39:56 -07001378 }
1379
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001380 VkImageFormatProperties format_limits = {};
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001381 VkResult res = GetPDImageFormatProperties(pCreateInfo, &format_limits);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001382 if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
1383 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1384 "vkCreateImage(): Format %s is not supported for this combination of parameters.",
1385 string_VkFormat(pCreateInfo->format));
1386 } else {
1387 if (pCreateInfo->mipLevels > format_limits.maxMipLevels) {
1388 const char *format_string = string_VkFormat(pCreateInfo->format);
1389 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
1390 "VUID-VkImageCreateInfo-mipLevels-02255",
1391 "vkCreateImage(): Image mip levels=%d exceed image format maxMipLevels=%d for format %s.",
1392 pCreateInfo->mipLevels, format_limits.maxMipLevels, format_string);
1393 }
Dave Houlton130c0212018-01-29 13:39:56 -07001394
Dave Houltona585d132019-01-18 13:05:42 -07001395 uint64_t texel_count = (uint64_t)pCreateInfo->extent.width * (uint64_t)pCreateInfo->extent.height *
1396 (uint64_t)pCreateInfo->extent.depth * (uint64_t)pCreateInfo->arrayLayers *
1397 (uint64_t)pCreateInfo->samples;
1398 uint64_t total_size = (uint64_t)std::ceil(FormatTexelSize(pCreateInfo->format) * texel_count);
Dave Houlton130c0212018-01-29 13:39:56 -07001399
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001400 // Round up to imageGranularity boundary
Mark Lobodzinski5c048802019-03-07 10:47:31 -07001401 VkDeviceSize imageGranularity = GetPDProperties()->limits.bufferImageGranularity;
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001402 uint64_t ig_mask = imageGranularity - 1;
1403 total_size = (total_size + ig_mask) & ~ig_mask;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001404
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001405 if (total_size > format_limits.maxResourceSize) {
1406 skip |= log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1407 kVUID_Core_Image_InvalidFormatLimitsViolation,
1408 "vkCreateImage(): resource size exceeds allowable maximum Image resource size = 0x%" PRIxLEAST64
1409 ", maximum resource size = 0x%" PRIxLEAST64 " ",
1410 total_size, format_limits.maxResourceSize);
1411 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001412
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001413 if (pCreateInfo->arrayLayers > format_limits.maxArrayLayers) {
1414 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1415 "VUID-VkImageCreateInfo-arrayLayers-02256",
1416 "vkCreateImage(): arrayLayers=%d exceeds allowable maximum supported by format of %d.",
1417 pCreateInfo->arrayLayers, format_limits.maxArrayLayers);
1418 }
1419
1420 if ((pCreateInfo->samples & format_limits.sampleCounts) == 0) {
1421 skip |=
1422 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, 0,
1423 "VUID-VkImageCreateInfo-samples-02258", "vkCreateImage(): samples %s is not supported by format 0x%.8X.",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001424 string_VkSampleCountFlagBits(pCreateInfo->samples), format_limits.sampleCounts);
Graeme Leese2cd2a1f2018-11-19 15:11:45 +00001425 }
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001426 }
1427
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001428 if ((pCreateInfo->flags & VK_IMAGE_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06001429 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 -06001430 "VUID-VkImageCreateInfo-flags-01924",
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001431 "vkCreateImage(): the sparseResidencyAliased device feature is disabled: Images cannot be created with the "
1432 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06001433 }
1434
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001435 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06001436 if (pCreateInfo->flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR) {
1437 if (!(FormatIsCompressed_BC(pCreateInfo->format) || FormatIsCompressed_ASTC_LDR(pCreateInfo->format) ||
1438 FormatIsCompressed_ETC2_EAC(pCreateInfo->format))) {
1439 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001440 skip |=
1441 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1442 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1443 "format must be block, ETC or ASTC compressed, but is %s",
1444 string_VkFormat(pCreateInfo->format));
Lenny Komowb79f04a2017-09-18 17:07:00 -06001445 }
1446 if (!(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
1447 // TODO: Add Maintenance2 VUID
Dave Houlton8e9f6542018-05-18 12:18:22 -06001448 skip |=
1449 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUIDUndefined,
1450 "vkCreateImage(): If pCreateInfo->flags contains VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR, "
1451 "flags must also contain VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT.");
Lenny Komowb79f04a2017-09-18 17:07:00 -06001452 }
1453 }
1454 }
1455
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001456 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001457 skip |=
1458 ValidateQueueFamilies(device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
1459 "vkCreateImage", "pCreateInfo->pQueueFamilyIndices", "VUID-VkImageCreateInfo-sharingMode-01420",
1460 "VUID-VkImageCreateInfo-sharingMode-01420", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07001461 }
1462
Mark Lobodzinskibdc3b022017-04-24 09:11:35 -06001463 return skip;
Mark Lobodzinski90224de2017-01-26 15:23:11 -07001464}
1465
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001466void CoreChecks::PostCallRecordCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
1467 const VkAllocationCallbacks *pAllocator, VkImage *pImage, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07001468 if (VK_SUCCESS != result) return;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001469 IMAGE_LAYOUT_NODE image_state;
1470 image_state.layout = pCreateInfo->initialLayout;
1471 image_state.format = pCreateInfo->format;
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001472 IMAGE_STATE *is_node = new IMAGE_STATE(*pImage, pCreateInfo);
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001473 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06001474 RecordCreateImageANDROID(pCreateInfo, is_node);
1475 }
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001476 GetImageMap()->insert(std::make_pair(*pImage, std::unique_ptr<IMAGE_STATE>(is_node)));
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001477 ImageSubresourcePair subpair{*pImage, false, VkImageSubresource()};
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001478 (*GetImageSubresourceMap())[*pImage].push_back(subpair);
1479 (*GetImageLayoutMap())[subpair] = image_state;
Mark Lobodzinski42fe5f72017-01-11 11:36:16 -07001480}
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001481
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001482bool CoreChecks::PreCallValidateDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001483 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001484 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001485 const VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001486 bool skip = false;
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001487 if (image_state) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001488 skip |= ValidateObjectNotInUse(device_data, image_state, obj_struct, "vkDestroyImage", "VUID-vkDestroyImage-image-01000");
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001489 }
1490 return skip;
1491}
1492
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001493void CoreChecks::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001494 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskidfa64112019-03-04 12:17:24 -07001495 if (!image) return;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001496 IMAGE_STATE *image_state = GetImageState(image);
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07001497 VK_OBJECT obj_struct = {HandleToUint64(image), kVulkanObjectTypeImage};
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001498 InvalidateCommandBuffers(device_data, image_state->cb_bindings, obj_struct);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001499 // Clean up memory mapping, bindings and range references for image
1500 for (auto mem_binding : image_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001501 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001502 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001503 RemoveImageMemoryRange(obj_struct.handle, mem_info);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001504 }
1505 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07001506 ClearMemoryObjectBindings(obj_struct.handle, kVulkanObjectTypeImage);
John Zulauf6b4aae82018-05-09 13:03:36 -06001507 EraseQFOReleaseBarriers<VkImageMemoryBarrier>(device_data, image);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001508 // Remove image from imageMap
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001509 GetImageMap()->erase(image);
1510 std::unordered_map<VkImage, std::vector<ImageSubresourcePair>> *imageSubresourceMap = GetImageSubresourceMap();
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001511
1512 const auto &sub_entry = imageSubresourceMap->find(image);
1513 if (sub_entry != imageSubresourceMap->end()) {
1514 for (const auto &pair : sub_entry->second) {
Mark Lobodzinski44d46d52019-03-07 11:04:06 -07001515 GetImageLayoutMap()->erase(pair);
Mark Lobodzinski9ef5d562017-01-27 12:28:30 -07001516 }
1517 imageSubresourceMap->erase(sub_entry);
1518 }
1519}
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001520
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001521bool CoreChecks::ValidateImageAttributes(layer_data *device_data, IMAGE_STATE *image_state, VkImageSubresourceRange range) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001522 bool skip = false;
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001523
1524 if (range.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) {
1525 char const str[] = "vkCmdClearColorImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_COLOR_BIT";
1526 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 -06001527 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001528 }
1529
Dave Houlton1d2022c2017-03-29 11:43:58 -06001530 if (FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001531 char const str[] = "vkCmdClearColorImage called with depth/stencil image.";
1532 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 -06001533 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Dave Houlton1d2022c2017-03-29 11:43:58 -06001534 } else if (FormatIsCompressed(image_state->createInfo.format)) {
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001535 char const str[] = "vkCmdClearColorImage called with compressed image.";
1536 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 -06001537 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00007", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001538 }
1539
1540 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSFER_DST_BIT)) {
1541 char const str[] = "vkCmdClearColorImage called with image created without VK_IMAGE_USAGE_TRANSFER_DST_BIT.";
1542 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 -06001543 HandleToUint64(image_state->image), "VUID-vkCmdClearColorImage-image-00002", "%s.", str);
Mark Lobodzinskic409a582017-01-27 15:16:01 -07001544 }
1545 return skip;
1546}
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001547
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001548uint32_t ResolveRemainingLevels(const VkImageSubresourceRange *range, uint32_t mip_levels) {
1549 // Return correct number of mip levels taking into account VK_REMAINING_MIP_LEVELS
1550 uint32_t mip_level_count = range->levelCount;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001551 if (range->levelCount == VK_REMAINING_MIP_LEVELS) {
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001552 mip_level_count = mip_levels - range->baseMipLevel;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001553 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001554 return mip_level_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001555}
1556
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001557uint32_t ResolveRemainingLayers(const VkImageSubresourceRange *range, uint32_t layers) {
1558 // Return correct number of layers taking into account VK_REMAINING_ARRAY_LAYERS
1559 uint32_t array_layer_count = range->layerCount;
1560 if (range->layerCount == VK_REMAINING_ARRAY_LAYERS) {
1561 array_layer_count = layers - range->baseArrayLayer;
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001562 }
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001563 return array_layer_count;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001564}
1565
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001566bool CoreChecks::VerifyClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, IMAGE_STATE *image_state,
1567 VkImageSubresourceRange range, VkImageLayout dest_image_layout, const char *func_name) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001568 bool skip = false;
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001569
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001570 uint32_t level_count = ResolveRemainingLevels(&range, image_state->createInfo.mipLevels);
1571 uint32_t layer_count = ResolveRemainingLayers(&range, image_state->createInfo.arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001572
1573 if (dest_image_layout != VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) {
1574 if (dest_image_layout == VK_IMAGE_LAYOUT_GENERAL) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001575 if (image_state->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
1576 // LAYOUT_GENERAL is allowed, but may not be performance optimal, flag as perf warning.
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001577 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 -06001578 HandleToUint64(image_state->image), kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001579 "%s: Layout for cleared image should be TRANSFER_DST_OPTIMAL instead of GENERAL.", func_name);
1580 }
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001581 } else if (VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR == dest_image_layout) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07001582 if (!GetDeviceExtensions()->vk_khr_shared_presentable_image) {
Tobin Ehlisfb0661c2017-05-11 08:52:51 -06001583 // TODO: Add unique error id when available.
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001584 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 -06001585 HandleToUint64(image_state->image), 0,
Dave Houlton33c2d252017-06-09 17:08:32 -06001586 "Must enable VK_KHR_shared_presentable_image extension before creating images with a layout type "
1587 "of VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.");
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001588
1589 } else {
1590 if (image_state->shared_presentable) {
1591 skip |= log_msg(
1592 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinski88529492018-04-01 10:38:15 -06001593 HandleToUint64(image_state->image), 0,
Mark Lobodzinski087380c2017-05-16 14:42:25 -06001594 "Layout for shared presentable cleared image is %s but can only be VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR.",
1595 string_VkImageLayout(dest_image_layout));
1596 }
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06001597 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001598 } else {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001599 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00005";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001600 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001601 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00012";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001602 } else {
1603 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1604 }
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06001605 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 -06001606 HandleToUint64(image_state->image), error_code,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06001607 "%s: Layout for cleared image is %s but can only be TRANSFER_DST_OPTIMAL or GENERAL.", func_name,
1608 string_VkImageLayout(dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001609 }
1610 }
1611
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001612 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1613 uint32_t level = level_index + range.baseMipLevel;
1614 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1615 uint32_t layer = layer_index + range.baseArrayLayer;
1616 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001617 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001618 if (FindCmdBufLayout(cb_node, image_state->image, sub, node)) {
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001619 if (node.layout != dest_image_layout) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06001620 const char *error_code = "VUID-vkCmdClearColorImage-imageLayout-00004";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001621 if (strcmp(func_name, "vkCmdClearDepthStencilImage()") == 0) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001622 error_code = "VUID-vkCmdClearDepthStencilImage-imageLayout-00011";
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001623 } else {
1624 assert(strcmp(func_name, "vkCmdClearColorImage()") == 0);
1625 }
Mark Lobodzinski88529492018-04-01 10:38:15 -06001626 skip |=
1627 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, 0,
1628 error_code, "%s: Cannot clear an image whose layout is %s and doesn't match the current layout %s.",
1629 func_name, string_VkImageLayout(dest_image_layout), string_VkImageLayout(node.layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001630 }
1631 }
1632 }
1633 }
1634
1635 return skip;
1636}
1637
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001638void CoreChecks::RecordClearImageLayout(layer_data *device_data, GLOBAL_CB_NODE *cb_node, VkImage image,
1639 VkImageSubresourceRange range, VkImageLayout dest_image_layout) {
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001640 VkImageCreateInfo *image_create_info = &(GetImageState(image)->createInfo);
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001641 uint32_t level_count = ResolveRemainingLevels(&range, image_create_info->mipLevels);
1642 uint32_t layer_count = ResolveRemainingLayers(&range, image_create_info->arrayLayers);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001643
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06001644 for (uint32_t level_index = 0; level_index < level_count; ++level_index) {
1645 uint32_t level = level_index + range.baseMipLevel;
1646 for (uint32_t layer_index = 0; layer_index < layer_count; ++layer_index) {
1647 uint32_t layer = layer_index + range.baseArrayLayer;
1648 VkImageSubresource sub = {range.aspectMask, level, layer};
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001649 IMAGE_CMD_BUF_LAYOUT_NODE node;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07001650 if (!FindCmdBufLayout(cb_node, image, sub, node)) {
1651 SetLayout(cb_node, image, sub, IMAGE_CMD_BUF_LAYOUT_NODE(dest_image_layout, dest_image_layout));
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001652 }
1653 }
1654 }
1655}
1656
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001657bool CoreChecks::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1658 const VkClearColorValue *pColor, uint32_t rangeCount,
1659 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001660 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1661
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001662 bool skip = false;
1663 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001664 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001665 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001666 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001667 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearColorImage()",
1668 "VUID-vkCmdClearColorImage-image-00003");
1669 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearColorImage()", VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001670 "VUID-vkCmdClearColorImage-commandBuffer-cmdpool");
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001671 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARCOLORIMAGE, "vkCmdClearColorImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001672 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001673 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
1674 "vkCmdClearColorImage", "VUID-vkCmdClearColorImage-image-01993",
1675 "VUID-vkCmdClearColorImage-image-01993");
Cort Stratton186b1a22018-05-01 20:18:06 -04001676 }
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001677 skip |= InsideRenderPass(device_data, cb_node, "vkCmdClearColorImage()", "VUID-vkCmdClearColorImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001678 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001679 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001680 skip |= ValidateCmdClearColorSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
1681 skip |= ValidateImageAttributes(device_data, image_state, pRanges[i]);
1682 skip |= VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearColorImage()");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001683 }
1684 }
1685 return skip;
1686}
1687
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001688void CoreChecks::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1689 const VkClearColorValue *pColor, uint32_t rangeCount,
1690 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001691 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1692
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001693 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001694 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001695 if (cb_node && image_state) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001696 AddCommandBufferBindingImage(device_data, cb_node, image_state);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001697 for (uint32_t i = 0; i < rangeCount; ++i) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001698 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001699 }
1700 }
1701}
1702
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001703bool CoreChecks::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1704 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1705 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001706 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001707 bool skip = false;
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001708
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001709 // TODO : Verify memory is in VK_IMAGE_STATE_CLEAR state
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001710 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001711 auto image_state = GetImageState(image);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001712 if (cb_node && image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06001713 skip |= ValidateMemoryIsBoundToImage(device_data, image_state, "vkCmdClearDepthStencilImage()",
1714 "VUID-vkCmdClearDepthStencilImage-image-00010");
Mike Schuchardt9c582402017-02-23 15:57:37 -07001715 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearDepthStencilImage()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06001716 "VUID-vkCmdClearDepthStencilImage-commandBuffer-cmdpool");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001717 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARDEPTHSTENCILIMAGE, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07001718 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04001719 skip |= ValidateImageFormatFeatureFlags(device_data, image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06001720 "vkCmdClearDepthStencilImage", "VUID-vkCmdClearDepthStencilImage-image-01994",
1721 "VUID-vkCmdClearDepthStencilImage-image-01994");
Cort Stratton186b1a22018-05-01 20:18:06 -04001722 }
Dave Houltond8ed0212018-05-16 17:18:24 -06001723 skip |=
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06001724 InsideRenderPass(device_data, cb_node, "vkCmdClearDepthStencilImage()", "VUID-vkCmdClearDepthStencilImage-renderpass");
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001725 for (uint32_t i = 0; i < rangeCount; ++i) {
Petr Kraus4d718682017-05-18 03:38:41 +02001726 std::string param_name = "pRanges[" + std::to_string(i) + "]";
Petr Krausffa94af2017-08-08 21:46:02 +02001727 skip |= ValidateCmdClearDepthSubresourceRange(device_data, image_state, pRanges[i], param_name.c_str());
Mark Lobodzinski9c93dbd2017-02-02 08:31:18 -07001728 skip |=
1729 VerifyClearImageLayout(device_data, cb_node, image_state, pRanges[i], imageLayout, "vkCmdClearDepthStencilImage()");
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001730 // Image aspect must be depth or stencil or both
Dave Houlton12befb92018-06-26 17:16:46 -06001731 VkImageAspectFlags valid_aspects = VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
1732 if (((pRanges[i].aspectMask & valid_aspects) == 0) || ((pRanges[i].aspectMask & ~valid_aspects) != 0)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001733 char const str[] =
Dave Houltona9df0ce2018-02-07 10:51:23 -07001734 "vkCmdClearDepthStencilImage aspectMasks for all subresource ranges must be set to VK_IMAGE_ASPECT_DEPTH_BIT "
1735 "and/or VK_IMAGE_ASPECT_STENCIL_BIT";
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001736 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 -06001737 HandleToUint64(commandBuffer), kVUID_Core_DrawState_InvalidImageAspect, str);
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001738 }
1739 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06001740 if (image_state && !FormatIsDepthOrStencil(image_state->createInfo.format)) {
Mark Lobodzinski1241a312017-02-01 10:57:21 -07001741 char const str[] = "vkCmdClearDepthStencilImage called without a depth/stencil image.";
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06001742 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 -06001743 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00014", "%s.", str);
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001744 }
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001745 if (VK_IMAGE_USAGE_TRANSFER_DST_BIT != (VK_IMAGE_USAGE_TRANSFER_DST_BIT & image_state->createInfo.usage)) {
1746 char const str[] =
1747 "vkCmdClearDepthStencilImage() called with an image that was not created with the VK_IMAGE_USAGE_TRANSFER_DST_BIT "
1748 "set.";
1749 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 -06001750 HandleToUint64(image), "VUID-vkCmdClearDepthStencilImage-image-00009", "%s.", str);
Tobin Ehlis4af8c242017-11-30 13:47:11 -07001751 }
Mark Lobodzinskid81d1012017-02-01 09:03:06 -07001752 }
1753 return skip;
1754}
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001755
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001756void CoreChecks::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
1757 const VkClearDepthStencilValue *pDepthStencil, uint32_t rangeCount,
1758 const VkImageSubresourceRange *pRanges) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001759 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
1760
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07001761 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07001762 auto image_state = GetImageState(image);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07001763 if (cb_node && image_state) {
1764 AddCommandBufferBindingImage(device_data, cb_node, image_state);
1765 for (uint32_t i = 0; i < rangeCount; ++i) {
1766 RecordClearImageLayout(device_data, cb_node, image, pRanges[i], imageLayout);
1767 }
1768 }
1769}
1770
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001771// Returns true if [x, xoffset] and [y, yoffset] overlap
1772static bool RangesIntersect(int32_t start, uint32_t start_offset, int32_t end, uint32_t end_offset) {
1773 bool result = false;
1774 uint32_t intersection_min = std::max(static_cast<uint32_t>(start), static_cast<uint32_t>(end));
1775 uint32_t intersection_max = std::min(static_cast<uint32_t>(start) + start_offset, static_cast<uint32_t>(end) + end_offset);
1776
1777 if (intersection_max > intersection_min) {
1778 result = true;
1779 }
1780 return result;
1781}
1782
Dave Houltonc991cc92018-03-06 11:08:51 -07001783// Returns true if source area of first copy region intersects dest area of second region
1784// It is assumed that these are copy regions within a single image (otherwise no possibility of collision)
1785static bool RegionIntersects(const VkImageCopy *rgn0, const VkImageCopy *rgn1, VkImageType type, bool is_multiplane) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001786 bool result = false;
Dave Houltonf5217612018-02-02 16:18:52 -07001787
Dave Houltonc991cc92018-03-06 11:08:51 -07001788 // Separate planes within a multiplane image cannot intersect
1789 if (is_multiplane && (rgn0->srcSubresource.aspectMask != rgn1->dstSubresource.aspectMask)) {
Dave Houltonf5217612018-02-02 16:18:52 -07001790 return result;
1791 }
1792
Dave Houltonc991cc92018-03-06 11:08:51 -07001793 if ((rgn0->srcSubresource.mipLevel == rgn1->dstSubresource.mipLevel) &&
1794 (RangesIntersect(rgn0->srcSubresource.baseArrayLayer, rgn0->srcSubresource.layerCount, rgn1->dstSubresource.baseArrayLayer,
1795 rgn1->dstSubresource.layerCount))) {
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001796 result = true;
1797 switch (type) {
1798 case VK_IMAGE_TYPE_3D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001799 result &= RangesIntersect(rgn0->srcOffset.z, rgn0->extent.depth, rgn1->dstOffset.z, rgn1->extent.depth);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001800 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001801 case VK_IMAGE_TYPE_2D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001802 result &= RangesIntersect(rgn0->srcOffset.y, rgn0->extent.height, rgn1->dstOffset.y, rgn1->extent.height);
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06001803 // fall through
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001804 case VK_IMAGE_TYPE_1D:
Dave Houltonc991cc92018-03-06 11:08:51 -07001805 result &= RangesIntersect(rgn0->srcOffset.x, rgn0->extent.width, rgn1->dstOffset.x, rgn1->extent.width);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001806 break;
1807 default:
1808 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
1809 assert(false);
1810 }
1811 }
1812 return result;
1813}
1814
Dave Houltonfc1a4052017-04-27 14:32:45 -06001815// Returns non-zero if offset and extent exceed image extents
1816static const uint32_t x_bit = 1;
1817static const uint32_t y_bit = 2;
1818static const uint32_t z_bit = 4;
Dave Houlton1150cf52017-04-27 14:38:11 -06001819static uint32_t ExceedsBounds(const VkOffset3D *offset, const VkExtent3D *extent, const VkExtent3D *image_extent) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001820 uint32_t result = 0;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001821 // Extents/depths cannot be negative but checks left in for clarity
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001822 if ((offset->z + extent->depth > image_extent->depth) || (offset->z < 0) ||
1823 ((offset->z + static_cast<int32_t>(extent->depth)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001824 result |= z_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001825 }
1826 if ((offset->y + extent->height > image_extent->height) || (offset->y < 0) ||
1827 ((offset->y + static_cast<int32_t>(extent->height)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001828 result |= y_bit;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001829 }
1830 if ((offset->x + extent->width > image_extent->width) || (offset->x < 0) ||
1831 ((offset->x + static_cast<int32_t>(extent->width)) < 0)) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001832 result |= x_bit;
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07001833 }
1834 return result;
1835}
1836
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001837// Test if two VkExtent3D structs are equivalent
1838static inline bool IsExtentEqual(const VkExtent3D *extent, const VkExtent3D *other_extent) {
1839 bool result = true;
1840 if ((extent->width != other_extent->width) || (extent->height != other_extent->height) ||
1841 (extent->depth != other_extent->depth)) {
1842 result = false;
1843 }
1844 return result;
1845}
1846
Dave Houltonee281a52017-12-08 13:51:02 -07001847// For image copies between compressed/uncompressed formats, the extent is provided in source image texels
1848// Destination image texel extents must be adjusted by block size for the dest validation checks
1849VkExtent3D GetAdjustedDestImageExtent(VkFormat src_format, VkFormat dst_format, VkExtent3D extent) {
1850 VkExtent3D adjusted_extent = extent;
1851 if ((FormatIsCompressed(src_format) && (!FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001852 VkExtent3D block_size = FormatTexelBlockExtent(src_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001853 adjusted_extent.width /= block_size.width;
1854 adjusted_extent.height /= block_size.height;
1855 adjusted_extent.depth /= block_size.depth;
1856 } else if ((!FormatIsCompressed(src_format) && (FormatIsCompressed(dst_format)))) {
Dave Houltona585d132019-01-18 13:05:42 -07001857 VkExtent3D block_size = FormatTexelBlockExtent(dst_format);
Dave Houltonee281a52017-12-08 13:51:02 -07001858 adjusted_extent.width *= block_size.width;
1859 adjusted_extent.height *= block_size.height;
1860 adjusted_extent.depth *= block_size.depth;
1861 }
1862 return adjusted_extent;
1863}
1864
Dave Houlton6f9059e2017-05-02 17:15:13 -06001865// Returns the effective extent of an image subresource, adjusted for mip level and array depth.
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001866static inline VkExtent3D GetImageSubresourceExtent(const IMAGE_STATE *img, const VkImageSubresourceLayers *subresource) {
1867 const uint32_t mip = subresource->mipLevel;
Dave Houltonfc1a4052017-04-27 14:32:45 -06001868
1869 // Return zero extent if mip level doesn't exist
Dave Houlton1150cf52017-04-27 14:38:11 -06001870 if (mip >= img->createInfo.mipLevels) {
1871 return VkExtent3D{0, 0, 0};
Dave Houltonfc1a4052017-04-27 14:32:45 -06001872 }
Dave Houlton1150cf52017-04-27 14:38:11 -06001873
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001874 // 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 -06001875 VkExtent3D extent = img->createInfo.extent;
Jeff Bolzef40fec2018-09-01 22:04:34 -05001876
Dave Houltone48cd112019-01-03 17:01:18 -07001877 // If multi-plane, adjust per-plane extent
1878 if (FormatIsMultiplane(img->createInfo.format)) {
1879 VkExtent2D divisors = FindMultiplaneExtentDivisors(img->createInfo.format, subresource->aspectMask);
1880 extent.width /= divisors.width;
1881 extent.height /= divisors.height;
1882 }
1883
Jeff Bolzef40fec2018-09-01 22:04:34 -05001884 if (img->createInfo.flags & VK_IMAGE_CREATE_CORNER_SAMPLED_BIT_NV) {
1885 extent.width = (0 == extent.width ? 0 : std::max(2U, 1 + ((extent.width - 1) >> mip)));
Dave Houlton142c4cb2018-10-17 15:04:41 -06001886 extent.height = (0 == extent.height ? 0 : std::max(2U, 1 + ((extent.height - 1) >> mip)));
Jeff Bolzef40fec2018-09-01 22:04:34 -05001887 extent.depth = (0 == extent.depth ? 0 : std::max(2U, 1 + ((extent.depth - 1) >> mip)));
1888 } else {
1889 extent.width = (0 == extent.width ? 0 : std::max(1U, extent.width >> mip));
1890 extent.height = (0 == extent.height ? 0 : std::max(1U, extent.height >> mip));
1891 extent.depth = (0 == extent.depth ? 0 : std::max(1U, extent.depth >> mip));
1892 }
Dave Houltonfc1a4052017-04-27 14:32:45 -06001893
Dave Houlton6f9059e2017-05-02 17:15:13 -06001894 // Image arrays have an effective z extent that isn't diminished by mip level
1895 if (VK_IMAGE_TYPE_3D != img->createInfo.imageType) {
Dave Houltonfc1a4052017-04-27 14:32:45 -06001896 extent.depth = img->createInfo.arrayLayers;
1897 }
1898
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001899 return extent;
1900}
1901
1902// Test if the extent argument has all dimensions set to 0.
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001903static inline bool IsExtentAllZeroes(const VkExtent3D *extent) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001904 return ((extent->width == 0) && (extent->height == 0) && (extent->depth == 0));
1905}
1906
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001907// Test if the extent argument has any dimensions set to 0.
1908static inline bool IsExtentSizeZero(const VkExtent3D *extent) {
1909 return ((extent->width == 0) || (extent->height == 0) || (extent->depth == 0));
1910}
1911
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001912// Returns the image transfer granularity for a specific image scaled by compressed block size if necessary.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001913VkExtent3D CoreChecks::GetScaledItg(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001914 // Default to (0, 0, 0) granularity in case we can't find the real granularity for the physical device.
1915 VkExtent3D granularity = {0, 0, 0};
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07001916 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001917 if (pPool) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001918 granularity = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].minImageTransferGranularity;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001919 if (FormatIsCompressed(img->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07001920 auto block_size = FormatTexelBlockExtent(img->createInfo.format);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001921 granularity.width *= block_size.width;
1922 granularity.height *= block_size.height;
1923 }
1924 }
1925 return granularity;
1926}
1927
1928// Test elements of a VkExtent3D structure against alignment constraints contained in another VkExtent3D structure
1929static inline bool IsExtentAligned(const VkExtent3D *extent, const VkExtent3D *granularity) {
1930 bool valid = true;
Dave Houlton1d2022c2017-03-29 11:43:58 -06001931 if ((SafeModulo(extent->depth, granularity->depth) != 0) || (SafeModulo(extent->width, granularity->width) != 0) ||
1932 (SafeModulo(extent->height, granularity->height) != 0)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001933 valid = false;
1934 }
1935 return valid;
1936}
1937
1938// Check elements of a VkOffset3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001939bool CoreChecks::CheckItgOffset(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkOffset3D *offset,
1940 const VkExtent3D *granularity, const uint32_t i, const char *function, const char *member,
1941 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001942 bool skip = false;
1943 VkExtent3D offset_extent = {};
1944 offset_extent.width = static_cast<uint32_t>(abs(offset->x));
1945 offset_extent.height = static_cast<uint32_t>(abs(offset->y));
1946 offset_extent.depth = static_cast<uint32_t>(abs(offset->z));
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001947 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001948 // 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 -07001949 if (IsExtentAllZeroes(&offset_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001950 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 -04001951 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001952 "%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 "
1953 "image transfer granularity is (w=0, h=0, d=0).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001954 function, i, member, offset->x, offset->y, offset->z);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001955 }
1956 } else {
1957 // If the queue family image transfer granularity is not (0, 0, 0), then the offset dimensions must always be even
1958 // integer multiples of the image transfer granularity.
1959 if (IsExtentAligned(&offset_extent, granularity) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001960 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 -04001961 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07001962 "%s: pRegion[%d].%s (x=%d, y=%d, z=%d) dimensions must be even integer multiples of this command "
1963 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d).",
Petr Krausbc7f5442017-05-14 23:43:38 +02001964 function, i, member, offset->x, offset->y, offset->z, granularity->width, granularity->height,
1965 granularity->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001966 }
1967 }
1968 return skip;
1969}
1970
1971// Check elements of a VkExtent3D structure against a queue family's Image Transfer Granularity values
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07001972bool CoreChecks::CheckItgExtent(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const VkExtent3D *extent,
1973 const VkOffset3D *offset, const VkExtent3D *granularity, const VkExtent3D *subresource_extent,
1974 const VkImageType image_type, const uint32_t i, const char *function, const char *member,
1975 const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001976 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07001977 if (IsExtentAllZeroes(granularity)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001978 // If the queue family image transfer granularity is (0, 0, 0), then the extent must always match the image
1979 // subresource extent.
1980 if (IsExtentEqual(extent, subresource_extent) == false) {
Petr Krausbc7f5442017-05-14 23:43:38 +02001981 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 -04001982 HandleToUint64(cb_node->commandBuffer), vuid,
Petr Krausbc7f5442017-05-14 23:43:38 +02001983 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d) "
1984 "when the command buffer's queue family image transfer granularity is (w=0, h=0, d=0).",
1985 function, i, member, extent->width, extent->height, extent->depth, subresource_extent->width,
1986 subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07001987 }
1988 } else {
1989 // If the queue family image transfer granularity is not (0, 0, 0), then the extent dimensions must always be even
1990 // integer multiples of the image transfer granularity or the offset + extent dimensions must always match the image
1991 // subresource extent dimensions.
1992 VkExtent3D offset_extent_sum = {};
1993 offset_extent_sum.width = static_cast<uint32_t>(abs(offset->x)) + extent->width;
1994 offset_extent_sum.height = static_cast<uint32_t>(abs(offset->y)) + extent->height;
1995 offset_extent_sum.depth = static_cast<uint32_t>(abs(offset->z)) + extent->depth;
Mark Lobodzinski283ade62017-10-09 16:36:49 -06001996 bool x_ok = true;
1997 bool y_ok = true;
1998 bool z_ok = true;
1999 switch (image_type) {
2000 case VK_IMAGE_TYPE_3D:
2001 z_ok = ((0 == SafeModulo(extent->depth, granularity->depth)) ||
2002 (subresource_extent->depth == offset_extent_sum.depth));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002003 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002004 case VK_IMAGE_TYPE_2D:
2005 y_ok = ((0 == SafeModulo(extent->height, granularity->height)) ||
2006 (subresource_extent->height == offset_extent_sum.height));
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06002007 // fall through
Mark Lobodzinski283ade62017-10-09 16:36:49 -06002008 case VK_IMAGE_TYPE_1D:
2009 x_ok = ((0 == SafeModulo(extent->width, granularity->width)) ||
2010 (subresource_extent->width == offset_extent_sum.width));
2011 break;
2012 default:
2013 // Unrecognized or new IMAGE_TYPE enums will be caught in parameter_validation
2014 assert(false);
2015 }
Dave Houlton6f9059e2017-05-02 17:15:13 -06002016 if (!(x_ok && y_ok && z_ok)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002017 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 -04002018 HandleToUint64(cb_node->commandBuffer), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002019 "%s: pRegion[%d].%s (w=%d, h=%d, d=%d) dimensions must be even integer multiples of this command "
2020 "buffer's queue family image transfer granularity (w=%d, h=%d, d=%d) or offset (x=%d, y=%d, z=%d) + "
2021 "extent (w=%d, h=%d, d=%d) must match the image subresource extents (w=%d, h=%d, d=%d).",
2022 function, i, member, extent->width, extent->height, extent->depth, granularity->width,
2023 granularity->height, granularity->depth, offset->x, offset->y, offset->z, extent->width, extent->height,
2024 extent->depth, subresource_extent->width, subresource_extent->height, subresource_extent->depth);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002025 }
2026 }
2027 return skip;
2028}
2029
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002030bool CoreChecks::ValidateImageMipLevel(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2031 uint32_t mip_level, const uint32_t i, const char *function, const char *member,
2032 const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002033 bool skip = false;
2034 if (mip_level >= img->createInfo.mipLevels) {
2035 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2036 HandleToUint64(cb_node->commandBuffer), vuid,
Lockee9aeebf2019-03-03 23:50:08 -07002037 "In %s, pRegions[%u].%s.mipLevel is %u, but provided image %s has %u mip levels.", function, i, member,
2038 mip_level, report_data->FormatHandle(img->image).c_str(), img->createInfo.mipLevels);
Cort Strattonff1542a2018-05-27 10:49:28 -07002039 }
2040 return skip;
2041}
2042
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002043bool CoreChecks::ValidateImageArrayLayerRange(layer_data *device_data, const GLOBAL_CB_NODE *cb_node, const IMAGE_STATE *img,
2044 const uint32_t base_layer, const uint32_t layer_count, const uint32_t i,
2045 const char *function, const char *member, const char *vuid) {
Cort Strattonff1542a2018-05-27 10:49:28 -07002046 bool skip = false;
2047 if (base_layer >= img->createInfo.arrayLayers || layer_count > img->createInfo.arrayLayers ||
2048 (base_layer + layer_count) > img->createInfo.arrayLayers) {
2049 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2050 HandleToUint64(cb_node->commandBuffer), vuid,
2051 "In %s, pRegions[%u].%s.baseArrayLayer is %u and .layerCount is "
Lockee9aeebf2019-03-03 23:50:08 -07002052 "%u, but provided image %s has %u array layers.",
2053 function, i, member, base_layer, layer_count, report_data->FormatHandle(img->image).c_str(),
2054 img->createInfo.arrayLayers);
Cort Strattonff1542a2018-05-27 10:49:28 -07002055 }
2056 return skip;
2057}
2058
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002059// Check valid usage Image Transfer Granularity requirements for elements of a VkBufferImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002060bool CoreChecks::ValidateCopyBufferImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2061 const IMAGE_STATE *img, const VkBufferImageCopy *region,
2062 const uint32_t i, const char *function, const char *vuid) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002063 bool skip = false;
Cort Stratton420ebd42018-05-04 01:12:23 -04002064 VkExtent3D granularity = GetScaledItg(device_data, cb_node, img);
2065 skip |= CheckItgOffset(device_data, cb_node, &region->imageOffset, &granularity, i, function, "imageOffset", vuid);
2066 VkExtent3D subresource_extent = GetImageSubresourceExtent(img, &region->imageSubresource);
2067 skip |= CheckItgExtent(device_data, cb_node, &region->imageExtent, &region->imageOffset, &granularity, &subresource_extent,
2068 img->createInfo.imageType, i, function, "imageExtent", vuid);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002069 return skip;
2070}
2071
Mark Lobodzinskibf0042d2018-02-26 16:01:22 -07002072// Check valid usage Image Transfer Granularity requirements for elements of a VkImageCopy structure
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002073bool CoreChecks::ValidateCopyImageTransferGranularityRequirements(layer_data *device_data, const GLOBAL_CB_NODE *cb_node,
2074 const IMAGE_STATE *src_img, const IMAGE_STATE *dst_img,
2075 const VkImageCopy *region, const uint32_t i,
2076 const char *function) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002077 bool skip = false;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002078 // Source image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002079 VkExtent3D granularity = GetScaledItg(device_data, cb_node, src_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002080 skip |= CheckItgOffset(device_data, cb_node, &region->srcOffset, &granularity, i, function, "srcOffset",
2081 "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002082 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_img, &region->srcSubresource);
Dave Houlton94a00372017-12-14 15:08:47 -07002083 const VkExtent3D extent = region->extent;
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002084 skip |= CheckItgExtent(device_data, cb_node, &extent, &region->srcOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002085 src_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-srcOffset-01783");
Dave Houlton6f9059e2017-05-02 17:15:13 -06002086
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002087 // Destination image checks
Dave Houlton6f9059e2017-05-02 17:15:13 -06002088 granularity = GetScaledItg(device_data, cb_node, dst_img);
Dave Houltond8ed0212018-05-16 17:18:24 -06002089 skip |= CheckItgOffset(device_data, cb_node, &region->dstOffset, &granularity, i, function, "dstOffset",
2090 "VUID-vkCmdCopyImage-dstOffset-01784");
Dave Houltonee281a52017-12-08 13:51:02 -07002091 // Adjust dest extent, if necessary
Dave Houlton94a00372017-12-14 15:08:47 -07002092 const VkExtent3D dest_effective_extent =
2093 GetAdjustedDestImageExtent(src_img->createInfo.format, dst_img->createInfo.format, extent);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002094 subresource_extent = GetImageSubresourceExtent(dst_img, &region->dstSubresource);
Dave Houltonee281a52017-12-08 13:51:02 -07002095 skip |= CheckItgExtent(device_data, cb_node, &dest_effective_extent, &region->dstOffset, &granularity, &subresource_extent,
Dave Houltond8ed0212018-05-16 17:18:24 -06002096 dst_img->createInfo.imageType, i, function, "extent", "VUID-vkCmdCopyImage-dstOffset-01784");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002097 return skip;
2098}
2099
Dave Houlton6f9059e2017-05-02 17:15:13 -06002100// Validate contents of a VkImageCopy struct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002101bool CoreChecks::ValidateImageCopyData(const layer_data *device_data, const debug_report_data *report_data,
2102 const uint32_t regionCount, const VkImageCopy *ic_regions, const IMAGE_STATE *src_state,
2103 const IMAGE_STATE *dst_state) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002104 bool skip = false;
2105
2106 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton94a00372017-12-14 15:08:47 -07002107 const VkImageCopy region = ic_regions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002108
2109 // For comp<->uncomp copies, the copy extent for the dest image must be adjusted
Dave Houlton94a00372017-12-14 15:08:47 -07002110 const VkExtent3D src_copy_extent = region.extent;
2111 const VkExtent3D dst_copy_extent =
Dave Houltonee281a52017-12-08 13:51:02 -07002112 GetAdjustedDestImageExtent(src_state->createInfo.format, dst_state->createInfo.format, region.extent);
2113
Dave Houlton6f9059e2017-05-02 17:15:13 -06002114 bool slice_override = false;
2115 uint32_t depth_slices = 0;
2116
2117 // Special case for copying between a 1D/2D array and a 3D image
2118 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2119 if ((VK_IMAGE_TYPE_3D == src_state->createInfo.imageType) && (VK_IMAGE_TYPE_3D != dst_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002120 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002121 slice_override = (depth_slices != 1);
2122 } 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 -07002123 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002124 slice_override = (depth_slices != 1);
2125 }
2126
2127 // Do all checks on source image
2128 //
2129 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002130 if ((0 != region.srcOffset.y) || (1 != src_copy_extent.height)) {
2131 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 -06002132 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00146",
Dave Houltonee281a52017-12-08 13:51:02 -07002133 "vkCmdCopyImage(): pRegion[%d] srcOffset.y is %d and extent.height is %d. For 1D images these must "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002134 "be 0 and 1, respectively.",
2135 i, region.srcOffset.y, src_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002136 }
2137 }
2138
Dave Houlton533be9f2018-03-26 17:08:30 -06002139 // VUID-VkImageCopy-srcImage-01785
2140 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.srcOffset.z) || (1 != src_copy_extent.depth))) {
2141 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 -06002142 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01785",
Dave Houlton533be9f2018-03-26 17:08:30 -06002143 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d and extent.depth is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002144 "these must be 0 and 1, respectively.",
2145 i, region.srcOffset.z, src_copy_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002146 }
2147
Dave Houlton533be9f2018-03-26 17:08:30 -06002148 // VUID-VkImageCopy-srcImage-01787
2149 if ((src_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.srcOffset.z)) {
2150 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 -06002151 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-01787",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002152 "vkCmdCopyImage(): pRegion[%d] srcOffset.z is %d. For 2D images the z-offset must be 0.", i,
2153 region.srcOffset.z);
Dave Houlton533be9f2018-03-26 17:08:30 -06002154 }
2155
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002156 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002157 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002158 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002159 skip |=
2160 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002161 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002162 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and srcSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002163 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2164 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002165 }
2166 }
2167 } else { // Pre maint 1
2168 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002169 if ((0 != region.srcSubresource.baseArrayLayer) || (1 != region.srcSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002170 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 -06002171 HandleToUint64(src_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002172 "vkCmdCopyImage(): pRegion[%d] srcSubresource.baseArrayLayer is %d and "
2173 "srcSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002174 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2175 i, region.srcSubresource.baseArrayLayer, region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002176 }
2177 }
2178 }
2179
Dave Houltonc991cc92018-03-06 11:08:51 -07002180 // Source checks that apply only to compressed images (or to _422 images if ycbcr enabled)
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002181 bool ext_ycbcr = GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion;
Dave Houltonc991cc92018-03-06 11:08:51 -07002182 if (FormatIsCompressed(src_state->createInfo.format) ||
2183 (ext_ycbcr && FormatIsSinglePlane_422(src_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002184 const VkExtent3D block_size = FormatTexelBlockExtent(src_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002185 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002186 if ((SafeModulo(region.srcOffset.x, block_size.width) != 0) ||
2187 (SafeModulo(region.srcOffset.y, block_size.height) != 0) ||
2188 (SafeModulo(region.srcOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002189 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01727" : "VUID-VkImageCopy-srcOffset-00157";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002190 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 -07002191 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002192 "vkCmdCopyImage(): pRegion[%d] srcOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002193 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002194 i, region.srcOffset.x, region.srcOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002195 }
2196
Dave Houlton94a00372017-12-14 15:08:47 -07002197 const VkExtent3D mip_extent = GetImageSubresourceExtent(src_state, &(region.srcSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002198 if ((SafeModulo(src_copy_extent.width, block_size.width) != 0) &&
2199 (src_copy_extent.width + region.srcOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002200 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01728" : "VUID-VkImageCopy-extent-00158";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002201 skip |=
2202 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002203 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002204 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002205 "width (%d), or when added to srcOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002206 i, src_copy_extent.width, block_size.width, region.srcOffset.x, mip_extent.width);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002207 }
2208
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002209 // Extent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houltonee281a52017-12-08 13:51:02 -07002210 if ((SafeModulo(src_copy_extent.height, block_size.height) != 0) &&
2211 (src_copy_extent.height + region.srcOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002212 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01729" : "VUID-VkImageCopy-extent-00159";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002213 skip |=
2214 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002215 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002216 "vkCmdCopyImage(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002217 "height (%d), or when added to srcOffset.y (%d) must equal the image subresource height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002218 i, src_copy_extent.height, block_size.height, region.srcOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002219 }
2220
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002221 // Extent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houltonee281a52017-12-08 13:51:02 -07002222 uint32_t copy_depth = (slice_override ? depth_slices : src_copy_extent.depth);
2223 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.srcOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002224 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-srcImage-01730" : "VUID-VkImageCopy-extent-00160";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002225 skip |=
2226 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002227 HandleToUint64(src_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002228 "vkCmdCopyImage(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block "
Dave Houltonc991cc92018-03-06 11:08:51 -07002229 "depth (%d), or when added to srcOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002230 i, src_copy_extent.depth, block_size.depth, region.srcOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002231 }
2232 } // Compressed
2233
2234 // Do all checks on dest image
2235 //
2236 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002237 if ((0 != region.dstOffset.y) || (1 != dst_copy_extent.height)) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07002238 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 -06002239 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-00152",
Dave Houltona9df0ce2018-02-07 10:51:23 -07002240 "vkCmdCopyImage(): pRegion[%d] dstOffset.y is %d and dst_copy_extent.height is %d. For 1D images "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002241 "these must be 0 and 1, respectively.",
2242 i, region.dstOffset.y, dst_copy_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002243 }
2244 }
2245
Dave Houlton533be9f2018-03-26 17:08:30 -06002246 // VUID-VkImageCopy-dstImage-01786
2247 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_1D) && ((0 != region.dstOffset.z) || (1 != dst_copy_extent.depth))) {
2248 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 -06002249 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01786",
Dave Houlton533be9f2018-03-26 17:08:30 -06002250 "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 -06002251 "and 1, respectively.",
2252 i, region.dstOffset.z, dst_copy_extent.depth);
Dave Houlton533be9f2018-03-26 17:08:30 -06002253 }
2254
2255 // VUID-VkImageCopy-dstImage-01788
2256 if ((dst_state->createInfo.imageType == VK_IMAGE_TYPE_2D) && (0 != region.dstOffset.z)) {
2257 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 -06002258 HandleToUint64(dst_state->image), "VUID-VkImageCopy-dstImage-01788",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002259 "vkCmdCopyImage(): pRegion[%d] dstOffset.z is %d. For 2D images the z-offset must be 0.", i,
2260 region.dstOffset.z);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002261 }
2262
2263 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002264 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002265 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-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002267 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002268 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2269 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002270 }
2271 }
2272 // VU01199 changed with mnt1
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002273 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002274 if (dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002275 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002276 skip |=
2277 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002278 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Dave Houlton6f9059e2017-05-02 17:15:13 -06002279 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and dstSubresource.layerCount "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002280 "is %d. For VK_IMAGE_TYPE_3D images these must be 0 and 1, respectively.",
2281 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002282 }
2283 }
2284 } else { // Pre maint 1
2285 if (src_state->createInfo.imageType == VK_IMAGE_TYPE_3D || dst_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
Dave Houltonee281a52017-12-08 13:51:02 -07002286 if ((0 != region.dstSubresource.baseArrayLayer) || (1 != region.dstSubresource.layerCount)) {
Petr Kraus13c98a62017-12-09 00:22:39 +01002287 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 -06002288 HandleToUint64(dst_state->image), "VUID-VkImageCopy-srcImage-00141",
Petr Kraus13c98a62017-12-09 00:22:39 +01002289 "vkCmdCopyImage(): pRegion[%d] dstSubresource.baseArrayLayer is %d and "
2290 "dstSubresource.layerCount is %d. For copies with either source or dest of type "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002291 "VK_IMAGE_TYPE_3D, these must be 0 and 1, respectively.",
2292 i, region.dstSubresource.baseArrayLayer, region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002293 }
2294 }
2295 }
2296
Dave Houltonc991cc92018-03-06 11:08:51 -07002297 // Dest checks that apply only to compressed images (or to _422 images if ycbcr enabled)
2298 if (FormatIsCompressed(dst_state->createInfo.format) ||
2299 (ext_ycbcr && FormatIsSinglePlane_422(dst_state->createInfo.format))) {
Dave Houltona585d132019-01-18 13:05:42 -07002300 const VkExtent3D block_size = FormatTexelBlockExtent(dst_state->createInfo.format);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002301
2302 // image offsets must be multiples of block dimensions
Dave Houltonee281a52017-12-08 13:51:02 -07002303 if ((SafeModulo(region.dstOffset.x, block_size.width) != 0) ||
2304 (SafeModulo(region.dstOffset.y, block_size.height) != 0) ||
2305 (SafeModulo(region.dstOffset.z, block_size.depth) != 0)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002306 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01731" : "VUID-VkImageCopy-dstOffset-00162";
Dave Houlton6f9059e2017-05-02 17:15:13 -06002307 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 -07002308 HandleToUint64(dst_state->image), vuid,
Dave Houlton6f9059e2017-05-02 17:15:13 -06002309 "vkCmdCopyImage(): pRegion[%d] dstOffset (%d, %d) must be multiples of the compressed image's "
Dave Houltonc991cc92018-03-06 11:08:51 -07002310 "texel width & height (%d, %d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002311 i, region.dstOffset.x, region.dstOffset.y, block_size.width, block_size.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002312 }
2313
Dave Houlton94a00372017-12-14 15:08:47 -07002314 const VkExtent3D mip_extent = GetImageSubresourceExtent(dst_state, &(region.dstSubresource));
Dave Houltonee281a52017-12-08 13:51:02 -07002315 if ((SafeModulo(dst_copy_extent.width, block_size.width) != 0) &&
2316 (dst_copy_extent.width + region.dstOffset.x != mip_extent.width)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002317 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01732" : "VUID-VkImageCopy-extent-00163";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002318 skip |=
2319 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002320 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002321 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002322 "block width (%d), or when added to dstOffset.x (%d) must equal the image subresource width (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002323 i, dst_copy_extent.width, block_size.width, region.dstOffset.x, mip_extent.width);
Mark Lobodzinskid0788802017-10-19 15:38:59 -06002324 }
2325
Dave Houltonee281a52017-12-08 13:51:02 -07002326 // Extent height must be a multiple of block height, or dst_copy_extent+offset height must equal subresource height
2327 if ((SafeModulo(dst_copy_extent.height, block_size.height) != 0) &&
2328 (dst_copy_extent.height + region.dstOffset.y != mip_extent.height)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002329 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01733" : "VUID-VkImageCopy-extent-00164";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002330 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 -07002331 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002332 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent height (%d) must be a multiple of the compressed "
2333 "texture block height (%d), or when added to dstOffset.y (%d) must equal the image subresource "
Dave Houltonc991cc92018-03-06 11:08:51 -07002334 "height (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002335 i, dst_copy_extent.height, block_size.height, region.dstOffset.y, mip_extent.height);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002336 }
2337
Dave Houltonee281a52017-12-08 13:51:02 -07002338 // Extent depth must be a multiple of block depth, or dst_copy_extent+offset depth must equal subresource depth
2339 uint32_t copy_depth = (slice_override ? depth_slices : dst_copy_extent.depth);
2340 if ((SafeModulo(copy_depth, block_size.depth) != 0) && (copy_depth + region.dstOffset.z != mip_extent.depth)) {
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06002341 const char *vuid = ext_ycbcr ? "VUID-VkImageCopy-dstImage-01734" : "VUID-VkImageCopy-extent-00165";
Dave Houltona9df0ce2018-02-07 10:51:23 -07002342 skip |=
2343 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltonc991cc92018-03-06 11:08:51 -07002344 HandleToUint64(dst_state->image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07002345 "vkCmdCopyImage(): pRegion[%d] dst_copy_extent width (%d) must be a multiple of the compressed texture "
Dave Houltonc991cc92018-03-06 11:08:51 -07002346 "block depth (%d), or when added to dstOffset.z (%d) must equal the image subresource depth (%d).",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002347 i, dst_copy_extent.depth, block_size.depth, region.dstOffset.z, mip_extent.depth);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002348 }
2349 } // Compressed
2350 }
2351 return skip;
2352}
2353
Dave Houltonc991cc92018-03-06 11:08:51 -07002354// vkCmdCopyImage checks that only apply if the multiplane extension is enabled
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002355bool CoreChecks::CopyImageMultiplaneValidation(const layer_data *dev_data, VkCommandBuffer command_buffer,
2356 const IMAGE_STATE *src_image_state, const IMAGE_STATE *dst_image_state,
2357 const VkImageCopy region) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002358 bool skip = false;
Dave Houltonc991cc92018-03-06 11:08:51 -07002359
2360 // Neither image is multiplane
2361 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format))) {
2362 // If neither image is multi-plane the aspectMask member of src and dst must match
2363 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
2364 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002365 ss << "vkCmdCopyImage(): Copy between non-multiplane images with differing aspectMasks ( 0x" << std::hex
Dave Houltonc991cc92018-03-06 11:08:51 -07002366 << region.srcSubresource.aspectMask << " and 0x" << region.dstSubresource.aspectMask << " )";
2367 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002368 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01551", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002369 }
2370 } else {
2371 // Source image multiplane checks
2372 uint32_t planes = FormatPlaneCount(src_image_state->createInfo.format);
2373 VkImageAspectFlags aspect = region.srcSubresource.aspectMask;
2374 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2375 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002376 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002377 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 -06002378 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01552", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002379 }
2380 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2381 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2382 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002383 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002384 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 -06002385 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01553", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002386 }
2387 // Single-plane to multi-plane
2388 if ((!FormatIsMultiplane(src_image_state->createInfo.format)) && (FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2389 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2390 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002391 ss << "vkCmdCopyImage(): Source image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002392 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 -06002393 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01557", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002394 }
2395
2396 // Dest image multiplane checks
2397 planes = FormatPlaneCount(dst_image_state->createInfo.format);
2398 aspect = region.dstSubresource.aspectMask;
2399 if ((2 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR)) {
2400 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002401 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 2-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002402 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 -06002403 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01554", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002404 }
2405 if ((3 == planes) && (aspect != VK_IMAGE_ASPECT_PLANE_0_BIT_KHR) && (aspect != VK_IMAGE_ASPECT_PLANE_1_BIT_KHR) &&
2406 (aspect != VK_IMAGE_ASPECT_PLANE_2_BIT_KHR)) {
2407 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002408 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is invalid for 3-plane format";
Dave Houltonc991cc92018-03-06 11:08:51 -07002409 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 -06002410 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstImage-01555", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002411 }
2412 // Multi-plane to single-plane
2413 if ((FormatIsMultiplane(src_image_state->createInfo.format)) && (!FormatIsMultiplane(dst_image_state->createInfo.format)) &&
2414 (VK_IMAGE_ASPECT_COLOR_BIT != aspect)) {
2415 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002416 ss << "vkCmdCopyImage(): Dest image aspect mask (0x" << std::hex << aspect << ") is not VK_IMAGE_ASPECT_COLOR_BIT";
Dave Houltonc991cc92018-03-06 11:08:51 -07002417 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 -06002418 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcImage-01556", "%s.", ss.str().c_str());
Dave Houltonc991cc92018-03-06 11:08:51 -07002419 }
2420 }
2421
2422 return skip;
2423}
2424
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002425bool CoreChecks::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2426 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2427 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002428 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002429 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002430 auto src_image_state = GetImageState(srcImage);
2431 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002432 bool skip = false;
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002433
2434 skip = ValidateImageCopyData(device_data, report_data, regionCount, pRegions, src_image_state, dst_image_state);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002435
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002436 VkCommandBuffer command_buffer = cb_node->commandBuffer;
2437
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002438 for (uint32_t i = 0; i < regionCount; i++) {
2439 const VkImageCopy region = pRegions[i];
Dave Houltonee281a52017-12-08 13:51:02 -07002440
2441 // For comp/uncomp copies, the copy extent for the dest image must be adjusted
2442 VkExtent3D src_copy_extent = region.extent;
2443 VkExtent3D dst_copy_extent =
2444 GetAdjustedDestImageExtent(src_image_state->createInfo.format, dst_image_state->createInfo.format, region.extent);
2445
Dave Houlton6f9059e2017-05-02 17:15:13 -06002446 bool slice_override = false;
2447 uint32_t depth_slices = 0;
2448
2449 // Special case for copying between a 1D/2D array and a 3D image
2450 // TBD: This seems like the only way to reconcile 3 mutually-exclusive VU checks for 2D/3D copies. Heads up.
2451 if ((VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType) &&
2452 (VK_IMAGE_TYPE_3D != dst_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002453 depth_slices = region.dstSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002454 slice_override = (depth_slices != 1);
2455 } else if ((VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType) &&
2456 (VK_IMAGE_TYPE_3D != src_image_state->createInfo.imageType)) {
Dave Houltonee281a52017-12-08 13:51:02 -07002457 depth_slices = region.srcSubresource.layerCount; // Slice count from 2D subresource
Dave Houlton6f9059e2017-05-02 17:15:13 -06002458 slice_override = (depth_slices != 1);
2459 }
2460
Cort Strattond619a302018-05-17 19:46:32 -07002461 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.srcSubresource, "vkCmdCopyImage", "srcSubresource", i);
2462 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &region.dstSubresource, "vkCmdCopyImage", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07002463 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, region.srcSubresource.mipLevel, i, "vkCmdCopyImage",
2464 "srcSubresource", "VUID-vkCmdCopyImage-srcSubresource-01696");
2465 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, region.dstSubresource.mipLevel, i, "vkCmdCopyImage",
2466 "dstSubresource", "VUID-vkCmdCopyImage-dstSubresource-01697");
2467 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, region.srcSubresource.baseArrayLayer,
2468 region.srcSubresource.layerCount, i, "vkCmdCopyImage", "srcSubresource",
2469 "VUID-vkCmdCopyImage-srcSubresource-01698");
2470 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, region.dstSubresource.baseArrayLayer,
2471 region.dstSubresource.layerCount, i, "vkCmdCopyImage", "dstSubresource",
2472 "VUID-vkCmdCopyImage-dstSubresource-01699");
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002473
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002474 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houlton6f9059e2017-05-02 17:15:13 -06002475 // No chance of mismatch if we're overriding depth slice count
2476 if (!slice_override) {
2477 // The number of depth slices in srcSubresource and dstSubresource must match
2478 // Depth comes from layerCount for 1D,2D resources, from extent.depth for 3D
2479 uint32_t src_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002480 (VK_IMAGE_TYPE_3D == src_image_state->createInfo.imageType ? src_copy_extent.depth
2481 : region.srcSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002482 uint32_t dst_slices =
Dave Houltonee281a52017-12-08 13:51:02 -07002483 (VK_IMAGE_TYPE_3D == dst_image_state->createInfo.imageType ? dst_copy_extent.depth
2484 : region.dstSubresource.layerCount);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002485 if (src_slices != dst_slices) {
2486 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002487 ss << "vkCmdCopyImage(): number of depth slices in source and destination subresources for pRegions[" << i
Dave Houlton6f9059e2017-05-02 17:15:13 -06002488 << "] do not match";
2489 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002490 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Dave Houlton6f9059e2017-05-02 17:15:13 -06002491 }
2492 }
2493 } else {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002494 // For each region the layerCount member of srcSubresource and dstSubresource must match
Dave Houltonee281a52017-12-08 13:51:02 -07002495 if (region.srcSubresource.layerCount != region.dstSubresource.layerCount) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002496 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002497 ss << "vkCmdCopyImage(): number of layers in source and destination subresources for pRegions[" << i
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002498 << "] do not match";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002499 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 -06002500 HandleToUint64(command_buffer), "VUID-VkImageCopy-extent-00140", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002501 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002502 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002503
Dave Houltonc991cc92018-03-06 11:08:51 -07002504 // Do multiplane-specific checks, if extension enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002505 if (GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonc991cc92018-03-06 11:08:51 -07002506 skip |= CopyImageMultiplaneValidation(device_data, command_buffer, src_image_state, dst_image_state, region);
2507 }
2508
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002509 if (!GetDeviceExtensions()->vk_khr_sampler_ycbcr_conversion) {
Dave Houltonf5217612018-02-02 16:18:52 -07002510 // not multi-plane, the aspectMask member of srcSubresource and dstSubresource must match
2511 if (region.srcSubresource.aspectMask != region.dstSubresource.aspectMask) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002512 char const str[] = "vkCmdCopyImage(): Src and dest aspectMasks for each region must match";
Dave Houltonf5217612018-02-02 16:18:52 -07002513 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 -06002514 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00137", "%s.", str);
Dave Houltonf5217612018-02-02 16:18:52 -07002515 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002516 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002517
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002518 // For each region, the aspectMask member of srcSubresource must be present in the source image
Dave Houltonee281a52017-12-08 13:51:02 -07002519 if (!VerifyAspectsPresent(region.srcSubresource.aspectMask, src_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002520 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002521 ss << "vkCmdCopyImage(): pRegion[" << i
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002522 << "] srcSubresource.aspectMask cannot specify aspects not present in source image";
2523 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 -06002524 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00142", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002525 }
2526
2527 // For each region, the aspectMask member of dstSubresource must be present in the destination image
Dave Houltonee281a52017-12-08 13:51:02 -07002528 if (!VerifyAspectsPresent(region.dstSubresource.aspectMask, dst_image_state->createInfo.format)) {
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002529 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002530 ss << "vkCmdCopyImage(): pRegion[" << i
2531 << "] dstSubresource.aspectMask cannot specify aspects not present in dest image";
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002532 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 -06002533 HandleToUint64(command_buffer), "VUID-VkImageCopy-aspectMask-00143", "%s.", ss.str().c_str());
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06002534 }
2535
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002536 // Check region extents for 1D-1D, 2D-2D, and 3D-3D copies
2537 if (src_image_state->createInfo.imageType == dst_image_state->createInfo.imageType) {
2538 // 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 -07002539 VkExtent3D img_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2540 if (0 != ExceedsBounds(&region.srcOffset, &src_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002541 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002542 ss << "vkCmdCopyImage(): Source pRegion[" << i << "] with mipLevel [ " << region.srcSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002543 << " ], offset [ " << region.srcOffset.x << ", " << region.srcOffset.y << ", " << region.srcOffset.z
2544 << " ], extent [ " << src_copy_extent.width << ", " << src_copy_extent.height << ", " << src_copy_extent.depth
2545 << " ] exceeds the source image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002546 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002547 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00122", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002548 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002549
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002550 // 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 -07002551 img_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2552 if (0 != ExceedsBounds(&region.dstOffset, &dst_copy_extent, &img_extent)) {
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002553 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002554 ss << "vkCmdCopyImage(): Dest pRegion[" << i << "] with mipLevel [ " << region.dstSubresource.mipLevel
Dave Houltonee281a52017-12-08 13:51:02 -07002555 << " ], offset [ " << region.dstOffset.x << ", " << region.dstOffset.y << ", " << region.dstOffset.z
2556 << " ], extent [ " << dst_copy_extent.width << ", " << dst_copy_extent.height << ", " << dst_copy_extent.depth
2557 << " ] exceeds the destination image dimensions";
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06002558 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 -06002559 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00123", "%s.", ss.str().c_str());
Mike Schuchardt64b5bb72017-03-21 16:33:26 -06002560 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002561 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002562
Dave Houltonfc1a4052017-04-27 14:32:45 -06002563 // Each dimension offset + extent limits must fall with image subresource extent
Dave Houltonee281a52017-12-08 13:51:02 -07002564 VkExtent3D subresource_extent = GetImageSubresourceExtent(src_image_state, &(region.srcSubresource));
2565 if (slice_override) src_copy_extent.depth = depth_slices;
2566 uint32_t extent_check = ExceedsBounds(&(region.srcOffset), &src_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002567 if (extent_check & x_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002568 skip |=
2569 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2570 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00144",
2571 "vkCmdCopyImage(): Source image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
2572 "width [%1d].",
2573 i, region.srcOffset.x, src_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002574 }
2575
2576 if (extent_check & y_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002577 skip |=
2578 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2579 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00145",
2580 "vkCmdCopyImage(): Source image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
2581 "height [%1d].",
2582 i, region.srcOffset.y, src_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002583 }
2584 if (extent_check & z_bit) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00002585 skip |=
2586 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2587 HandleToUint64(command_buffer), "VUID-VkImageCopy-srcOffset-00147",
2588 "vkCmdCopyImage(): Source image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
2589 "depth [%1d].",
2590 i, region.srcOffset.z, src_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002591 }
2592
Dave Houltonee281a52017-12-08 13:51:02 -07002593 // Adjust dest extent if necessary
2594 subresource_extent = GetImageSubresourceExtent(dst_image_state, &(region.dstSubresource));
2595 if (slice_override) dst_copy_extent.depth = depth_slices;
2596
2597 extent_check = ExceedsBounds(&(region.dstOffset), &dst_copy_extent, &subresource_extent);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002598 if (extent_check & x_bit) {
2599 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 -06002600 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00150",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002601 "vkCmdCopyImage(): Dest image pRegion %1d x-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002602 "width [%1d].",
2603 i, region.dstOffset.x, dst_copy_extent.width, subresource_extent.width);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002604 }
2605 if (extent_check & y_bit) {
2606 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 -06002607 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00151",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002608 "vkCmdCopyImage(): Dest image pRegion %1d y-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002609 "height [%1d].",
2610 i, region.dstOffset.y, dst_copy_extent.height, subresource_extent.height);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002611 }
2612 if (extent_check & z_bit) {
2613 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 -06002614 HandleToUint64(command_buffer), "VUID-VkImageCopy-dstOffset-00153",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002615 "vkCmdCopyImage(): Dest image pRegion %1d z-dimension offset [%1d] + extent [%1d] exceeds subResource "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002616 "depth [%1d].",
2617 i, region.dstOffset.z, dst_copy_extent.depth, subresource_extent.depth);
Dave Houltonfc1a4052017-04-27 14:32:45 -06002618 }
2619
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002620 // The union of all source regions, and the union of all destination regions, specified by the elements of regions,
2621 // must not overlap in memory
2622 if (src_image_state->image == dst_image_state->image) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002623 for (uint32_t j = 0; j < regionCount; j++) {
2624 if (RegionIntersects(&region, &pRegions[j], src_image_state->createInfo.imageType,
Dave Houltonf5217612018-02-02 16:18:52 -07002625 FormatIsMultiplane(src_image_state->createInfo.format))) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002626 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00002627 ss << "vkCmdCopyImage(): pRegions[" << i << "] src overlaps with pRegions[" << j << "].";
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002628 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 -06002629 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-pRegions-00124", "%s.", ss.str().c_str());
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002630 }
2631 }
2632 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002633 }
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002634
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002635 // The formats of src_image and dst_image must be compatible. Formats are considered compatible if their texel size in bytes
2636 // is the same between both formats. For example, VK_FORMAT_R8G8B8A8_UNORM is compatible with VK_FORMAT_R32_UINT because
2637 // because both texels are 4 bytes in size. Depth/stencil formats must match exactly.
Dave Houlton1150cf52017-04-27 14:38:11 -06002638 if (FormatIsDepthOrStencil(src_image_state->createInfo.format) || FormatIsDepthOrStencil(dst_image_state->createInfo.format)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002639 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2640 char const str[] = "vkCmdCopyImage called with unmatched source and dest image depth/stencil formats.";
Petr Krausbc7f5442017-05-14 23:43:38 +02002641 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 -06002642 HandleToUint64(command_buffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002643 }
2644 } else {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002645 if (!FormatSizesAreEqual(src_image_state->createInfo.format, dst_image_state->createInfo.format, regionCount, pRegions)) {
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002646 char const str[] = "vkCmdCopyImage called with unmatched source and dest image format sizes.";
2647 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 -06002648 HandleToUint64(command_buffer), "VUID-vkCmdCopyImage-srcImage-00135", "%s.", str);
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002649 }
2650 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002651
Dave Houlton33c22b72017-02-28 13:16:02 -07002652 // Source and dest image sample counts must match
2653 if (src_image_state->createInfo.samples != dst_image_state->createInfo.samples) {
2654 char const str[] = "vkCmdCopyImage() called on image pair with non-identical sample counts.";
2655 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-srcImage-00136", "%s", str);
Dave Houlton33c22b72017-02-28 13:16:02 -07002657 }
2658
Dave Houltond8ed0212018-05-16 17:18:24 -06002659 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-srcImage-00127");
2660 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-dstImage-00132");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002661 // Validate that SRC & DST images have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06002662 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
2663 "VUID-vkCmdCopyImage-srcImage-00126", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
2664 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
2665 "VUID-vkCmdCopyImage-dstImage-00131", "vkCmdCopyImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07002666 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002667 skip |=
2668 ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002669 "VUID-vkCmdCopyImage-srcImage-01995", "VUID-vkCmdCopyImage-srcImage-01995");
Dave Houltond8ed0212018-05-16 17:18:24 -06002670 skip |=
2671 ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT, "vkCmdCopyImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002672 "VUID-vkCmdCopyImage-dstImage-01996", "VUID-vkCmdCopyImage-dstImage-01996");
Cort Stratton186b1a22018-05-01 20:18:06 -04002673 }
Mike Schuchardt9c582402017-02-23 15:57:37 -07002674 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06002675 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
2676 "VUID-vkCmdCopyImage-commandBuffer-cmdpool");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002677 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGE, "vkCmdCopyImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002678 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImage()", "VUID-vkCmdCopyImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06002679 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002680 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002681 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002682 ? "VUID-vkCmdCopyImage-srcImageLayout-01917"
2683 : "VUID-vkCmdCopyImage-srcImageLayout-00129";
Jeff Bolzfdd0d852019-02-03 21:55:12 -06002684 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002685 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07002686 ? "VUID-vkCmdCopyImage-dstImageLayout-01395"
2687 : "VUID-vkCmdCopyImage-dstImageLayout-00134";
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002688 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002689 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002690 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImage()", invalid_src_layout_vuid,
2691 "VUID-vkCmdCopyImage-srcImageLayout-00128", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002692 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002693 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyImage()", invalid_dst_layout_vuid,
2694 "VUID-vkCmdCopyImage-dstImageLayout-00133", &hit_error);
Dave Houlton6f9059e2017-05-02 17:15:13 -06002695 skip |= ValidateCopyImageTransferGranularityRequirements(device_data, cb_node, src_image_state, dst_image_state,
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002696 &pRegions[i], i, "vkCmdCopyImage()");
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002697 }
2698
Mark Lobodzinskib39d2ec2017-02-02 14:38:47 -07002699 return skip;
2700}
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002701
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002702void CoreChecks::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2703 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2704 const VkImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002705 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002706 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002707 auto src_image_state = GetImageState(srcImage);
2708 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002709
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002710 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07002711 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002712 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
2713 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06002714 }
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002715 // Update bindings between images and cmd buffer
2716 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
2717 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07002718}
2719
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002720// Returns true if sub_rect is entirely contained within rect
2721static inline bool ContainsRect(VkRect2D rect, VkRect2D sub_rect) {
2722 if ((sub_rect.offset.x < rect.offset.x) || (sub_rect.offset.x + sub_rect.extent.width > rect.offset.x + rect.extent.width) ||
2723 (sub_rect.offset.y < rect.offset.y) || (sub_rect.offset.y + sub_rect.extent.height > rect.offset.y + rect.extent.height))
2724 return false;
2725 return true;
2726}
2727
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002728bool CoreChecks::ValidateClearAttachmentExtent(layer_data *device_data, VkCommandBuffer command_buffer, uint32_t attachment_index,
2729 FRAMEBUFFER_STATE *framebuffer, uint32_t fb_attachment, const VkRect2D &render_area,
2730 uint32_t rect_count, const VkClearRect *clear_rects) {
John Zulauf3a548ef2019-02-01 16:14:07 -07002731 bool skip = false;
John Zulauff2582972019-02-09 14:53:30 -07002732 const IMAGE_VIEW_STATE *image_view_state = nullptr;
2733 if (framebuffer && (fb_attachment != VK_ATTACHMENT_UNUSED) && (fb_attachment < framebuffer->createInfo.attachmentCount)) {
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07002734 image_view_state = GetImageViewState(framebuffer->createInfo.pAttachments[fb_attachment]);
John Zulauff2582972019-02-09 14:53:30 -07002735 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002736
2737 for (uint32_t j = 0; j < rect_count; j++) {
2738 if (!ContainsRect(render_area, clear_rects[j].rect)) {
2739 skip |= log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2740 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00016",
2741 "vkCmdClearAttachments(): The area defined by pRects[%d] is not contained in the area of "
2742 "the current render pass instance.",
2743 j);
2744 }
2745
2746 if (image_view_state) {
2747 // The layers specified by a given element of pRects must be contained within every attachment that
2748 // pAttachments refers to
2749 const auto attachment_layer_count = image_view_state->create_info.subresourceRange.layerCount;
2750 if ((clear_rects[j].baseArrayLayer >= attachment_layer_count) ||
2751 (clear_rects[j].baseArrayLayer + clear_rects[j].layerCount > attachment_layer_count)) {
2752 skip |=
2753 log_msg(device_data->report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2754 HandleToUint64(command_buffer), "VUID-vkCmdClearAttachments-pRects-00017",
2755 "vkCmdClearAttachments(): The layers defined in pRects[%d] are not contained in the layers "
2756 "of pAttachment[%d].",
2757 j, attachment_index);
2758 }
2759 }
2760 }
2761 return skip;
2762}
2763
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002764bool CoreChecks::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
2765 const VkClearAttachment *pAttachments, uint32_t rectCount,
2766 const VkClearRect *pRects) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07002767 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
2768
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002769 GLOBAL_CB_NODE *cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002770
2771 bool skip = false;
2772 if (cb_node) {
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06002773 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdClearAttachments()", VK_QUEUE_GRAPHICS_BIT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002774 "VUID-vkCmdClearAttachments-commandBuffer-cmdpool");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002775 skip |= ValidateCmd(device_data, cb_node, CMD_CLEARATTACHMENTS, "vkCmdClearAttachments()");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002776 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Chris Forbes05375e72017-04-21 13:15:15 -07002777 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002778 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2779 // 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 -07002780 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2781 // CmdClearAttachments.
Lockee9aeebf2019-03-03 23:50:08 -07002782 skip |=
2783 log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2784 HandleToUint64(commandBuffer), kVUID_Core_DrawState_ClearCmdBeforeDraw,
2785 "vkCmdClearAttachments() issued on command buffer object %s prior to any Draw Cmds. It is recommended you "
2786 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2787 report_data->FormatHandle(commandBuffer).c_str());
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002788 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002789 skip |= OutsideRenderPass(device_data, cb_node, "vkCmdClearAttachments()", "VUID-vkCmdClearAttachments-renderpass");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002790 }
2791
2792 // Validate that attachment is in reference list of active subpass
2793 if (cb_node->activeRenderPass) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01002794 const VkRenderPassCreateInfo2KHR *renderpass_create_info = cb_node->activeRenderPass->createInfo.ptr();
John Zulauff2582972019-02-09 14:53:30 -07002795 const uint32_t renderpass_attachment_count = renderpass_create_info->attachmentCount;
Tobias Hectorbbb12282018-10-22 15:17:59 +01002796 const VkSubpassDescription2KHR *subpass_desc = &renderpass_create_info->pSubpasses[cb_node->activeSubpass];
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002797 auto framebuffer = GetFramebufferState(cb_node->activeFramebuffer);
John Zulauf3a548ef2019-02-01 16:14:07 -07002798 const auto &render_area = cb_node->activeRenderPassBeginInfo.renderArea;
2799 std::shared_ptr<std::vector<VkClearRect>> clear_rect_copy;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002800
John Zulauf3a548ef2019-02-01 16:14:07 -07002801 for (uint32_t attachment_index = 0; attachment_index < attachmentCount; attachment_index++) {
2802 auto clear_desc = &pAttachments[attachment_index];
2803 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002804
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002805 if (0 == clear_desc->aspectMask) {
2806 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 -06002807 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-requiredbitmask", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002808 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
2809 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 -06002810 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00020", " ");
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002811 } else if (clear_desc->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
John Zulauff2582972019-02-09 14:53:30 -07002812 uint32_t color_attachment = VK_ATTACHMENT_UNUSED;
2813 if (clear_desc->colorAttachment < subpass_desc->colorAttachmentCount) {
2814 color_attachment = subpass_desc->pColorAttachments[clear_desc->colorAttachment].attachment;
2815 if ((color_attachment != VK_ATTACHMENT_UNUSED) && (color_attachment >= renderpass_attachment_count)) {
Lockee9aeebf2019-03-03 23:50:08 -07002816 skip |= log_msg(
2817 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2818 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2819 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u is not VK_ATTACHMENT_UNUSED "
2820 "and not a valid attachment for render pass %s attachmentCount=%u. Subpass %u pColorAttachment[%u]=%u.",
2821 attachment_index, clear_desc->colorAttachment,
2822 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(), cb_node->activeSubpass,
2823 clear_desc->colorAttachment, color_attachment, renderpass_attachment_count);
2824
John Zulauff2582972019-02-09 14:53:30 -07002825 color_attachment = VK_ATTACHMENT_UNUSED; // Defensive, prevent lookup past end of renderpass attachment
2826 }
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002827 } else {
Lockee9aeebf2019-03-03 23:50:08 -07002828 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2829 HandleToUint64(commandBuffer), "VUID-vkCmdClearAttachments-aspectMask-02501",
2830 "vkCmdClearAttachments() pAttachments[%u].colorAttachment=%u out of range for render pass %s"
2831 " subpass %u. colorAttachmentCount=%u",
2832 attachment_index, clear_desc->colorAttachment,
2833 report_data->FormatHandle(cb_node->activeRenderPass->renderPass).c_str(),
2834 cb_node->activeSubpass, subpass_desc->colorAttachmentCount);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002835 }
John Zulauff2582972019-02-09 14:53:30 -07002836 fb_attachment = color_attachment;
2837
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002838 if ((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) ||
2839 (clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)) {
2840 char const str[] =
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002841 "vkCmdClearAttachments() aspectMask [%d] must set only VK_IMAGE_ASPECT_COLOR_BIT of a color attachment.";
John Zulauf3a548ef2019-02-01 16:14:07 -07002842 skip |=
2843 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
2844 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-00019", str, attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002845 }
2846 } else { // Must be depth and/or stencil
2847 if (((clear_desc->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) &&
2848 ((clear_desc->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06002849 char const str[] = "vkCmdClearAttachments() aspectMask [%d] is not a valid combination of bits.";
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002850 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 -07002851 HandleToUint64(commandBuffer), "VUID-VkClearAttachment-aspectMask-parameter", str,
2852 attachment_index);
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002853 }
2854 if (!subpass_desc->pDepthStencilAttachment ||
2855 (subpass_desc->pDepthStencilAttachment->attachment == VK_ATTACHMENT_UNUSED)) {
2856 skip |= log_msg(
2857 report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06002858 HandleToUint64(commandBuffer), kVUID_Core_DrawState_MissingAttachmentReference,
Mark Lobodzinskiac7e51e2017-02-02 15:50:27 -07002859 "vkCmdClearAttachments() depth/stencil clear with no depth/stencil attachment in subpass; ignored");
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002860 } else {
John Zulauf3a548ef2019-02-01 16:14:07 -07002861 fb_attachment = subpass_desc->pDepthStencilAttachment->attachment;
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002862 }
2863 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002864 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_PRIMARY) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002865 skip |= ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer, fb_attachment,
2866 render_area, rectCount, pRects);
John Zulauf3a548ef2019-02-01 16:14:07 -07002867 } else {
2868 // if a secondary level command buffer inherits the framebuffer from the primary command buffer
2869 // (see VkCommandBufferInheritanceInfo), this validation must be deferred until queue submit time
2870 if (!clear_rect_copy) {
2871 // We need a copy of the clear rectangles that will persist until the last lambda executes
2872 // but we want to create it as lazily as possible
2873 clear_rect_copy.reset(new std::vector<VkClearRect>(pRects, pRects + rectCount));
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002874 }
John Zulauf3a548ef2019-02-01 16:14:07 -07002875
2876 auto val_fn = [device_data, commandBuffer, attachment_index, fb_attachment, rectCount, clear_rect_copy](
2877 GLOBAL_CB_NODE *prim_cb, VkFramebuffer fb) {
2878 assert(rectCount == clear_rect_copy->size());
Mark Lobodzinski74772ca2019-03-06 16:15:06 -07002879 FRAMEBUFFER_STATE *framebuffer = device_data->GetFramebufferState(fb);
John Zulauf3a548ef2019-02-01 16:14:07 -07002880 const auto &render_area = prim_cb->activeRenderPassBeginInfo.renderArea;
2881 bool skip = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002882 skip =
2883 device_data->ValidateClearAttachmentExtent(device_data, commandBuffer, attachment_index, framebuffer,
2884 fb_attachment, render_area, rectCount, clear_rect_copy->data());
John Zulauf3a548ef2019-02-01 16:14:07 -07002885 return skip;
2886 };
2887 cb_node->cmd_execute_commands_functions.emplace_back(val_fn);
Mark Lobodzinski2def2bf2017-02-02 15:22:50 -07002888 }
2889 }
2890 }
2891 return skip;
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002892}
2893
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002894bool CoreChecks::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2895 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2896 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002897 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002898 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002899 auto src_image_state = GetImageState(srcImage);
2900 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002901
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002902 bool skip = false;
2903 if (cb_node && src_image_state && dst_image_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06002904 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdResolveImage()",
2905 "VUID-vkCmdResolveImage-srcImage-00256");
2906 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdResolveImage()",
2907 "VUID-vkCmdResolveImage-dstImage-00258");
2908 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdResolveImage()", VK_QUEUE_GRAPHICS_BIT,
2909 "VUID-vkCmdResolveImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002910 skip |= ValidateCmd(device_data, cb_node, CMD_RESOLVEIMAGE, "vkCmdResolveImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06002911 skip |= InsideRenderPass(device_data, cb_node, "vkCmdResolveImage()", "VUID-vkCmdResolveImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04002912 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06002913 "vkCmdResolveImage()", "VUID-vkCmdResolveImage-dstImage-02003",
2914 "VUID-vkCmdResolveImage-dstImage-02003");
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002915
Cort Stratton7df30962018-05-17 19:45:57 -07002916 bool hit_error = false;
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002917 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002918 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002919 ? "VUID-vkCmdResolveImage-srcImageLayout-01400"
2920 : "VUID-vkCmdResolveImage-srcImageLayout-00261";
2921 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07002922 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002923 ? "VUID-vkCmdResolveImage-dstImageLayout-01401"
2924 : "VUID-vkCmdResolveImage-dstImageLayout-00263";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002925 // For each region, the number of layers in the image subresource should not be zero
2926 // For each region, src and dest image aspect must be color only
2927 for (uint32_t i = 0; i < regionCount; i++) {
Cort Strattond619a302018-05-17 19:46:32 -07002928 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].srcSubresource, "vkCmdResolveImage()",
2929 "srcSubresource", i);
2930 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].dstSubresource, "vkCmdResolveImage()",
2931 "dstSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002932 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002933 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdResolveImage()", invalid_src_layout_vuid,
2934 "VUID-vkCmdResolveImage-srcImageLayout-00260", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07002935 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07002936 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdResolveImage()", invalid_dst_layout_vuid,
2937 "VUID-vkCmdResolveImage-dstImageLayout-00262", &hit_error);
Cort Strattonff1542a2018-05-27 10:49:28 -07002938 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.mipLevel, i,
2939 "vkCmdResolveImage()", "srcSubresource", "VUID-vkCmdResolveImage-srcSubresource-01709");
2940 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.mipLevel, i,
2941 "vkCmdResolveImage()", "dstSubresource", "VUID-vkCmdResolveImage-dstSubresource-01710");
2942 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].srcSubresource.baseArrayLayer,
2943 pRegions[i].srcSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2944 "VUID-vkCmdResolveImage-srcSubresource-01711");
2945 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].dstSubresource.baseArrayLayer,
2946 pRegions[i].dstSubresource.layerCount, i, "vkCmdResolveImage()", "srcSubresource",
2947 "VUID-vkCmdResolveImage-dstSubresource-01712");
Cort Stratton7df30962018-05-17 19:45:57 -07002948
2949 // layer counts must match
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002950 if (pRegions[i].srcSubresource.layerCount != pRegions[i].dstSubresource.layerCount) {
2951 skip |= log_msg(
2952 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06002953 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-layerCount-00267",
Graeme Leese79b60cb2018-11-28 11:51:20 +00002954 "vkCmdResolveImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002955 }
Cort Stratton7df30962018-05-17 19:45:57 -07002956 // For each region, src and dest image aspect must be color only
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002957 if ((pRegions[i].srcSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT) ||
2958 (pRegions[i].dstSubresource.aspectMask != VK_IMAGE_ASPECT_COLOR_BIT)) {
2959 char const str[] =
Graeme Leese79b60cb2018-11-28 11:51:20 +00002960 "vkCmdResolveImage(): src and dest aspectMasks for each region must specify only VK_IMAGE_ASPECT_COLOR_BIT";
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002961 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 -06002962 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageResolve-aspectMask-00266", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002963 }
2964 }
2965
2966 if (src_image_state->createInfo.format != dst_image_state->createInfo.format) {
2967 char const str[] = "vkCmdResolveImage called with unmatched source and dest formats.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002968 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 -06002969 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageFormat, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002970 }
2971 if (src_image_state->createInfo.imageType != dst_image_state->createInfo.imageType) {
2972 char const str[] = "vkCmdResolveImage called with unmatched source and dest image types.";
Mark Lobodzinski50fbef12017-02-06 15:31:33 -07002973 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 -06002974 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_MismatchedImageType, str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002975 }
2976 if (src_image_state->createInfo.samples == VK_SAMPLE_COUNT_1_BIT) {
2977 char const str[] = "vkCmdResolveImage called with source sample count less than 2.";
2978 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 -06002979 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-srcImage-00257", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002980 }
2981 if (dst_image_state->createInfo.samples != VK_SAMPLE_COUNT_1_BIT) {
2982 char const str[] = "vkCmdResolveImage called with dest sample count greater than 1.";
2983 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 -06002984 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdResolveImage-dstImage-00259", "%s.", str);
Mark Lobodzinski2a3368e2017-02-06 15:29:37 -07002985 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07002986 } else {
2987 assert(0);
2988 }
2989 return skip;
2990}
2991
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07002992void CoreChecks::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2993 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2994 const VkImageResolve *pRegions) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002995 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07002996 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07002997 auto src_image_state = GetImageState(srcImage);
2998 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07002999
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003000 // Update bindings between images and cmd buffer
3001 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3002 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003003}
3004
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003005bool CoreChecks::PreCallValidateCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3006 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3007 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003008 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003009 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003010 auto src_image_state = GetImageState(srcImage);
3011 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003012
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003013 bool skip = false;
John Zulauf5c2750c2018-01-30 15:04:56 -07003014 if (cb_node) {
3015 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
3016 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003017 if (cb_node && src_image_state && dst_image_state) {
3018 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003019 "VUID-vkCmdBlitImage-srcImage-00233");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003020 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdBlitImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06003021 "VUID-vkCmdBlitImage-dstImage-00234");
3022 skip |=
3023 ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-srcImage-00220");
3024 skip |=
3025 ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-dstImage-00225");
3026 skip |=
3027 ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
3028 "VUID-vkCmdBlitImage-srcImage-00219", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
3029 skip |=
3030 ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
3031 "VUID-vkCmdBlitImage-dstImage-00224", "vkCmdBlitImage()", "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
3032 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdBlitImage()", VK_QUEUE_GRAPHICS_BIT,
3033 "VUID-vkCmdBlitImage-commandBuffer-cmdpool");
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003034 skip |= ValidateCmd(device_data, cb_node, CMD_BLITIMAGE, "vkCmdBlitImage()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003035 skip |= InsideRenderPass(device_data, cb_node, "vkCmdBlitImage()", "VUID-vkCmdBlitImage-renderpass");
Cort Stratton186b1a22018-05-01 20:18:06 -04003036 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_BLIT_SRC_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003037 "VUID-vkCmdBlitImage-srcImage-01999", "VUID-vkCmdBlitImage-srcImage-01999");
Cort Stratton186b1a22018-05-01 20:18:06 -04003038 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_BLIT_DST_BIT, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003039 "VUID-vkCmdBlitImage-dstImage-02000", "VUID-vkCmdBlitImage-dstImage-02000");
Cort Stratton186b1a22018-05-01 20:18:06 -04003040
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003041 // TODO: Need to validate image layouts, which will include layout validation for shared presentable images
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003042
Dave Houlton33c2d252017-06-09 17:08:32 -06003043 VkFormat src_format = src_image_state->createInfo.format;
3044 VkFormat dst_format = dst_image_state->createInfo.format;
3045 VkImageType src_type = src_image_state->createInfo.imageType;
3046 VkImageType dst_type = dst_image_state->createInfo.imageType;
3047
Cort Stratton186b1a22018-05-01 20:18:06 -04003048 if (VK_FILTER_LINEAR == filter) {
3049 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003050 "vkCmdBlitImage()", "VUID-vkCmdBlitImage-filter-02001",
3051 "VUID-vkCmdBlitImage-filter-02001");
Cort Stratton186b1a22018-05-01 20:18:06 -04003052 } else if (VK_FILTER_CUBIC_IMG == filter) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003053 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state,
3054 VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_IMG, "vkCmdBlitImage()",
Shannon McPherson40c0cba2018-08-07 13:39:13 -06003055 "VUID-vkCmdBlitImage-filter-02002", "VUID-vkCmdBlitImage-filter-02002");
Dave Houlton33c2d252017-06-09 17:08:32 -06003056 }
3057
3058 if ((VK_FILTER_CUBIC_IMG == filter) && (VK_IMAGE_TYPE_3D != src_type)) {
3059 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 -06003060 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-filter-00237",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003061 "vkCmdBlitImage(): source image type must be VK_IMAGE_TYPE_3D when cubic filtering is specified.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003062 }
3063
Dave Houlton33c2d252017-06-09 17:08:32 -06003064 if ((VK_SAMPLE_COUNT_1_BIT != src_image_state->createInfo.samples) ||
3065 (VK_SAMPLE_COUNT_1_BIT != dst_image_state->createInfo.samples)) {
3066 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 -06003067 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00228",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003068 "vkCmdBlitImage(): source or dest image has sample count other than VK_SAMPLE_COUNT_1_BIT.");
Dave Houlton33c2d252017-06-09 17:08:32 -06003069 }
3070
3071 // Validate consistency for unsigned formats
3072 if (FormatIsUInt(src_format) != FormatIsUInt(dst_format)) {
3073 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003074 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has unsigned integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003075 << "the other one must also have unsigned integer format. "
3076 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3077 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 -06003078 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00230", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003079 }
3080
3081 // Validate consistency for signed formats
3082 if (FormatIsSInt(src_format) != FormatIsSInt(dst_format)) {
3083 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003084 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has signed integer format, "
Dave Houlton33c2d252017-06-09 17:08:32 -06003085 << "the other one must also have signed integer format. "
3086 << "Source format is " << string_VkFormat(src_format) << " Destination format is " << string_VkFormat(dst_format);
3087 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003088 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00229", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003089 }
3090
3091 // Validate filter for Depth/Stencil formats
3092 if (FormatIsDepthOrStencil(src_format) && (filter != VK_FILTER_NEAREST)) {
3093 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003094 ss << "vkCmdBlitImage(): If the format of srcImage is a depth, stencil, or depth stencil "
Dave Houlton33c2d252017-06-09 17:08:32 -06003095 << "then filter must be VK_FILTER_NEAREST.";
3096 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 -06003097 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00232", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003098 }
3099
3100 // Validate aspect bits and formats for depth/stencil images
3101 if (FormatIsDepthOrStencil(src_format) || FormatIsDepthOrStencil(dst_format)) {
3102 if (src_format != dst_format) {
3103 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003104 ss << "vkCmdBlitImage(): If one of srcImage and dstImage images has a format of depth, stencil or depth "
Dave Houlton33c2d252017-06-09 17:08:32 -06003105 << "stencil, the other one must have exactly the same format. "
3106 << "Source format is " << string_VkFormat(src_format) << " Destination format is "
3107 << string_VkFormat(dst_format);
Dave Houltond8ed0212018-05-16 17:18:24 -06003108 skip |=
3109 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3110 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-srcImage-00231", "%s.", ss.str().c_str());
Dave Houlton33c2d252017-06-09 17:08:32 -06003111 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003112 } // Depth or Stencil
3113
3114 // Do per-region checks
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003115 const char *invalid_src_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003116 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003117 ? "VUID-vkCmdBlitImage-srcImageLayout-01398"
3118 : "VUID-vkCmdBlitImage-srcImageLayout-00222";
3119 const char *invalid_dst_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003120 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003121 ? "VUID-vkCmdBlitImage-dstImageLayout-01399"
3122 : "VUID-vkCmdBlitImage-dstImageLayout-00227";
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003123 for (uint32_t i = 0; i < regionCount; i++) {
3124 const VkImageBlit rgn = pRegions[i];
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003125 bool hit_error = false;
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003126 skip |= VerifyImageLayout(cb_node, src_image_state, rgn.srcSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003127 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdBlitImage()", invalid_src_layout_vuid,
3128 "VUID-vkCmdBlitImage-srcImageLayout-00221", &hit_error);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003129 skip |= VerifyImageLayout(cb_node, dst_image_state, rgn.dstSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07003130 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdBlitImage()", invalid_dst_layout_vuid,
3131 "VUID-vkCmdBlitImage-dstImageLayout-00226", &hit_error);
Cort Strattond619a302018-05-17 19:46:32 -07003132 skip |=
3133 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.srcSubresource, "vkCmdBlitImage()", "srcSubresource", i);
3134 skip |=
3135 ValidateImageSubresourceLayers(device_data, cb_node, &rgn.dstSubresource, "vkCmdBlitImage()", "dstSubresource", i);
Cort Strattonff1542a2018-05-27 10:49:28 -07003136 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, rgn.srcSubresource.mipLevel, i, "vkCmdBlitImage()",
3137 "srcSubresource", "VUID-vkCmdBlitImage-srcSubresource-01705");
3138 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, rgn.dstSubresource.mipLevel, i, "vkCmdBlitImage()",
3139 "dstSubresource", "VUID-vkCmdBlitImage-dstSubresource-01706");
3140 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, rgn.srcSubresource.baseArrayLayer,
3141 rgn.srcSubresource.layerCount, i, "vkCmdBlitImage()", "srcSubresource",
3142 "VUID-vkCmdBlitImage-srcSubresource-01707");
3143 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, rgn.dstSubresource.baseArrayLayer,
3144 rgn.dstSubresource.layerCount, i, "vkCmdBlitImage()", "dstSubresource",
3145 "VUID-vkCmdBlitImage-dstSubresource-01708");
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003146 // Warn for zero-sized regions
Dave Houlton48989f32017-05-26 15:01:46 -06003147 if ((rgn.srcOffsets[0].x == rgn.srcOffsets[1].x) || (rgn.srcOffsets[0].y == rgn.srcOffsets[1].y) ||
3148 (rgn.srcOffsets[0].z == rgn.srcOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003149 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003150 ss << "vkCmdBlitImage(): pRegions[" << i << "].srcOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003151 skip |=
3152 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3153 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003154 }
Dave Houlton48989f32017-05-26 15:01:46 -06003155 if ((rgn.dstOffsets[0].x == rgn.dstOffsets[1].x) || (rgn.dstOffsets[0].y == rgn.dstOffsets[1].y) ||
3156 (rgn.dstOffsets[0].z == rgn.dstOffsets[1].z)) {
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003157 std::stringstream ss;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003158 ss << "vkCmdBlitImage(): pRegions[" << i << "].dstOffsets specify a zero-volume area.";
Dave Houlton51653902018-06-22 17:32:13 -06003159 skip |=
3160 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3161 HandleToUint64(cb_node->commandBuffer), kVUID_Core_DrawState_InvalidExtents, "%s", ss.str().c_str());
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003162 }
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003163
3164 // Check that src/dst layercounts match
Dave Houlton48989f32017-05-26 15:01:46 -06003165 if (rgn.srcSubresource.layerCount != rgn.dstSubresource.layerCount) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003166 skip |= log_msg(
3167 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3168 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-layerCount-00239",
3169 "vkCmdBlitImage(): layerCount in source and destination subresource of pRegions[%d] does not match.", i);
Mark Lobodzinski23c81142017-02-06 15:04:23 -07003170 }
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003171
Dave Houlton48989f32017-05-26 15:01:46 -06003172 if (rgn.srcSubresource.aspectMask != rgn.dstSubresource.aspectMask) {
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003173 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 -06003174 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00238",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003175 "vkCmdBlitImage(): aspectMask members for pRegion[%d] do not match.", i);
Mark Lobodzinskie7e85fd2017-02-07 13:44:57 -07003176 }
Dave Houlton48989f32017-05-26 15:01:46 -06003177
Dave Houlton33c2d252017-06-09 17:08:32 -06003178 if (!VerifyAspectsPresent(rgn.srcSubresource.aspectMask, src_format)) {
3179 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 -06003180 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00241",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003181 "vkCmdBlitImage(): region [%d] source aspectMask (0x%x) specifies aspects not present in source "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003182 "image format %s.",
3183 i, rgn.srcSubresource.aspectMask, string_VkFormat(src_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003184 }
3185
3186 if (!VerifyAspectsPresent(rgn.dstSubresource.aspectMask, dst_format)) {
3187 skip |= log_msg(
3188 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003189 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-aspectMask-00242",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003190 "vkCmdBlitImage(): region [%d] dest aspectMask (0x%x) specifies aspects not present in dest image format %s.",
3191 i, rgn.dstSubresource.aspectMask, string_VkFormat(dst_format));
Dave Houlton33c2d252017-06-09 17:08:32 -06003192 }
3193
Dave Houlton48989f32017-05-26 15:01:46 -06003194 // Validate source image offsets
3195 VkExtent3D src_extent = GetImageSubresourceExtent(src_image_state, &(rgn.srcSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003196 if (VK_IMAGE_TYPE_1D == src_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003197 if ((0 != rgn.srcOffsets[0].y) || (1 != rgn.srcOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003198 skip |=
3199 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3200 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00245",
3201 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D with srcOffset[].y values "
3202 "of (%1d, %1d). These must be (0, 1).",
3203 i, rgn.srcOffsets[0].y, rgn.srcOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003204 }
3205 }
3206
Dave Houlton33c2d252017-06-09 17:08:32 -06003207 if ((VK_IMAGE_TYPE_1D == src_type) || (VK_IMAGE_TYPE_2D == src_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003208 if ((0 != rgn.srcOffsets[0].z) || (1 != rgn.srcOffsets[1].z)) {
3209 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 -06003210 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00247",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003211 "vkCmdBlitImage(): region [%d], source image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003212 "srcOffset[].z values of (%1d, %1d). These must be (0, 1).",
3213 i, rgn.srcOffsets[0].z, rgn.srcOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003214 }
3215 }
3216
Dave Houlton33c2d252017-06-09 17:08:32 -06003217 bool oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003218 if ((rgn.srcOffsets[0].x < 0) || (rgn.srcOffsets[0].x > static_cast<int32_t>(src_extent.width)) ||
3219 (rgn.srcOffsets[1].x < 0) || (rgn.srcOffsets[1].x > static_cast<int32_t>(src_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003220 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003221 skip |= log_msg(
3222 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3223 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00243",
3224 "vkCmdBlitImage(): region [%d] srcOffset[].x values (%1d, %1d) exceed srcSubresource width extent (%1d).", i,
3225 rgn.srcOffsets[0].x, rgn.srcOffsets[1].x, src_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003226 }
3227 if ((rgn.srcOffsets[0].y < 0) || (rgn.srcOffsets[0].y > static_cast<int32_t>(src_extent.height)) ||
3228 (rgn.srcOffsets[1].y < 0) || (rgn.srcOffsets[1].y > static_cast<int32_t>(src_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003229 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003230 skip |= log_msg(
3231 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003232 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00244",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003233 "vkCmdBlitImage(): region [%d] srcOffset[].y values (%1d, %1d) exceed srcSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003234 rgn.srcOffsets[0].y, rgn.srcOffsets[1].y, src_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003235 }
3236 if ((rgn.srcOffsets[0].z < 0) || (rgn.srcOffsets[0].z > static_cast<int32_t>(src_extent.depth)) ||
3237 (rgn.srcOffsets[1].z < 0) || (rgn.srcOffsets[1].z > static_cast<int32_t>(src_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003238 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003239 skip |= log_msg(
3240 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3241 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcOffset-00246",
3242 "vkCmdBlitImage(): region [%d] srcOffset[].z values (%1d, %1d) exceed srcSubresource depth extent (%1d).", i,
3243 rgn.srcOffsets[0].z, rgn.srcOffsets[1].z, src_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003244 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003245 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003246 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 -06003247 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00215",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003248 "vkCmdBlitImage(): region [%d] source image blit region exceeds image dimensions.", i);
Dave Houlton33c2d252017-06-09 17:08:32 -06003249 }
Dave Houlton48989f32017-05-26 15:01:46 -06003250
3251 // Validate dest image offsets
3252 VkExtent3D dst_extent = GetImageSubresourceExtent(dst_image_state, &(rgn.dstSubresource));
Dave Houlton33c2d252017-06-09 17:08:32 -06003253 if (VK_IMAGE_TYPE_1D == dst_type) {
Dave Houlton48989f32017-05-26 15:01:46 -06003254 if ((0 != rgn.dstOffsets[0].y) || (1 != rgn.dstOffsets[1].y)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003255 skip |=
3256 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3257 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00250",
3258 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D with dstOffset[].y values of "
3259 "(%1d, %1d). These must be (0, 1).",
3260 i, rgn.dstOffsets[0].y, rgn.dstOffsets[1].y);
Dave Houlton48989f32017-05-26 15:01:46 -06003261 }
3262 }
3263
Dave Houlton33c2d252017-06-09 17:08:32 -06003264 if ((VK_IMAGE_TYPE_1D == dst_type) || (VK_IMAGE_TYPE_2D == dst_type)) {
Dave Houlton48989f32017-05-26 15:01:46 -06003265 if ((0 != rgn.dstOffsets[0].z) || (1 != rgn.dstOffsets[1].z)) {
3266 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 -06003267 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstImage-00252",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003268 "vkCmdBlitImage(): region [%d], dest image of type VK_IMAGE_TYPE_1D or VK_IMAGE_TYPE_2D with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003269 "dstOffset[].z values of (%1d, %1d). These must be (0, 1).",
3270 i, rgn.dstOffsets[0].z, rgn.dstOffsets[1].z);
Dave Houlton48989f32017-05-26 15:01:46 -06003271 }
3272 }
3273
Dave Houlton33c2d252017-06-09 17:08:32 -06003274 oob = false;
Dave Houlton48989f32017-05-26 15:01:46 -06003275 if ((rgn.dstOffsets[0].x < 0) || (rgn.dstOffsets[0].x > static_cast<int32_t>(dst_extent.width)) ||
3276 (rgn.dstOffsets[1].x < 0) || (rgn.dstOffsets[1].x > static_cast<int32_t>(dst_extent.width))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003277 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003278 skip |= log_msg(
3279 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3280 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00248",
3281 "vkCmdBlitImage(): region [%d] dstOffset[].x values (%1d, %1d) exceed dstSubresource width extent (%1d).", i,
3282 rgn.dstOffsets[0].x, rgn.dstOffsets[1].x, dst_extent.width);
Dave Houlton48989f32017-05-26 15:01:46 -06003283 }
3284 if ((rgn.dstOffsets[0].y < 0) || (rgn.dstOffsets[0].y > static_cast<int32_t>(dst_extent.height)) ||
3285 (rgn.dstOffsets[1].y < 0) || (rgn.dstOffsets[1].y > static_cast<int32_t>(dst_extent.height))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003286 oob = true;
Dave Houlton48989f32017-05-26 15:01:46 -06003287 skip |= log_msg(
3288 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06003289 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00249",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003290 "vkCmdBlitImage(): region [%d] dstOffset[].y values (%1d, %1d) exceed dstSubresource height extent (%1d).", i,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003291 rgn.dstOffsets[0].y, rgn.dstOffsets[1].y, dst_extent.height);
Dave Houlton48989f32017-05-26 15:01:46 -06003292 }
3293 if ((rgn.dstOffsets[0].z < 0) || (rgn.dstOffsets[0].z > static_cast<int32_t>(dst_extent.depth)) ||
3294 (rgn.dstOffsets[1].z < 0) || (rgn.dstOffsets[1].z > static_cast<int32_t>(dst_extent.depth))) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003295 oob = true;
Graeme Leese79b60cb2018-11-28 11:51:20 +00003296 skip |= log_msg(
3297 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3298 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-dstOffset-00251",
3299 "vkCmdBlitImage(): region [%d] dstOffset[].z values (%1d, %1d) exceed dstSubresource depth extent (%1d).", i,
3300 rgn.dstOffsets[0].z, rgn.dstOffsets[1].z, dst_extent.depth);
Dave Houlton48989f32017-05-26 15:01:46 -06003301 }
Cort Strattonff1542a2018-05-27 10:49:28 -07003302 if (oob) {
Dave Houlton33c2d252017-06-09 17:08:32 -06003303 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 -06003304 HandleToUint64(cb_node->commandBuffer), "VUID-vkCmdBlitImage-pRegions-00216",
Graeme Leese79b60cb2018-11-28 11:51:20 +00003305 "vkCmdBlitImage(): region [%d] destination image blit region exceeds image dimensions.", i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003306 }
3307
Dave Houlton33c2d252017-06-09 17:08:32 -06003308 if ((VK_IMAGE_TYPE_3D == src_type) || (VK_IMAGE_TYPE_3D == dst_type)) {
3309 if ((0 != rgn.srcSubresource.baseArrayLayer) || (1 != rgn.srcSubresource.layerCount) ||
3310 (0 != rgn.dstSubresource.baseArrayLayer) || (1 != rgn.dstSubresource.layerCount)) {
Graeme Leese79b60cb2018-11-28 11:51:20 +00003311 skip |=
3312 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3313 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageBlit-srcImage-00240",
3314 "vkCmdBlitImage(): region [%d] blit to/from a 3D image type with a non-zero baseArrayLayer, or a "
3315 "layerCount other than 1.",
3316 i);
Mark Lobodzinski9ad96582017-02-06 14:01:54 -07003317 }
3318 }
Dave Houlton33c2d252017-06-09 17:08:32 -06003319 } // per-region checks
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003320 } else {
3321 assert(0);
3322 }
3323 return skip;
3324}
3325
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003326void CoreChecks::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3327 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3328 const VkImageBlit *pRegions, VkFilter filter) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003329 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07003330 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07003331 auto src_image_state = GetImageState(srcImage);
3332 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003333
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003334 // Make sure that all image slices are updated to correct layout
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07003335 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003336 SetImageLayout(cb_node, src_image_state, pRegions[i].srcSubresource, srcImageLayout);
3337 SetImageLayout(cb_node, dst_image_state, pRegions[i].dstSubresource, dstImageLayout);
Norbert Garnys7bd4c2c2017-11-16 10:58:04 +01003338 }
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003339 // Update bindings between images and cmd buffer
3340 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
3341 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinski8e0c0bf2017-02-06 11:06:26 -07003342}
3343
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003344// This validates that the initial layout specified in the command buffer for the IMAGE is the same as the global IMAGE layout
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003345bool CoreChecks::ValidateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003346 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> const &globalImageLayoutMap,
3347 std::unordered_map<ImageSubresourcePair, IMAGE_LAYOUT_NODE> &overlayLayoutMap) {
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003348 bool skip = false;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003349 for (auto cb_image_data : pCB->imageLayoutMap) {
3350 VkImageLayout imageLayout;
Tony Barbourdf013b92017-01-25 12:53:48 -07003351
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003352 if (FindLayout(overlayLayoutMap, cb_image_data.first, imageLayout) ||
3353 FindLayout(globalImageLayoutMap, cb_image_data.first, imageLayout)) {
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003354 if (cb_image_data.second.initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3355 // TODO: Set memory invalid which is in mem_tracker currently
3356 } else if (imageLayout != cb_image_data.second.initialLayout) {
3357 if (cb_image_data.first.hasSubresource) {
Shannon McPherson449fa9c2018-10-25 11:51:07 -06003358 skip |=
3359 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3360 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
Lockee9aeebf2019-03-03 23:50:08 -07003361 "Submitted command buffer expects image %s (subresource: aspectMask 0x%X array layer %u, mip level "
3362 "%u) to be in layout %s--instead, image %s's current layout is %s.",
3363 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3364 cb_image_data.first.subresource.aspectMask, cb_image_data.first.subresource.arrayLayer,
3365 cb_image_data.first.subresource.mipLevel, string_VkImageLayout(cb_image_data.second.initialLayout),
3366 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
3367 } else {
3368 skip |= log_msg(
3369 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3370 HandleToUint64(pCB->commandBuffer), kVUID_Core_DrawState_InvalidImageLayout,
3371 "Submitted command buffer expects image %s to be in layout %s--instead, image %s's current layout is %s.",
3372 report_data->FormatHandle(cb_image_data.first.image).c_str(),
3373 string_VkImageLayout(cb_image_data.second.initialLayout),
3374 report_data->FormatHandle(cb_image_data.first.image).c_str(), string_VkImageLayout(imageLayout));
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003375 }
3376 }
Chris Forbesf9d7acd2017-06-26 17:57:39 -07003377 SetLayout(overlayLayoutMap, cb_image_data.first, cb_image_data.second.layout);
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003378 }
3379 }
Mark Lobodzinskib0dd9472017-02-07 16:38:17 -07003380 return skip;
Mark Lobodzinski4a3065e2017-02-07 16:36:03 -07003381}
Mark Lobodzinskib3829a52017-02-07 16:55:53 -07003382
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003383void CoreChecks::UpdateCmdBufImageLayouts(GLOBAL_CB_NODE *pCB) {
Tony Barbourdf013b92017-01-25 12:53:48 -07003384 for (auto cb_image_data : pCB->imageLayoutMap) {
3385 VkImageLayout imageLayout;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003386 FindGlobalLayout(cb_image_data.first, imageLayout);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07003387 SetGlobalLayout(cb_image_data.first, cb_image_data.second.layout);
Tony Barbourdf013b92017-01-25 12:53:48 -07003388 }
3389}
3390
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003391// ValidateLayoutVsAttachmentDescription is a general function where we can validate various state associated with the
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003392// VkAttachmentDescription structs that are used by the sub-passes of a renderpass. Initial check is to make sure that READ_ONLY
3393// layout attachments don't have CLEAR as their loadOp.
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003394bool CoreChecks::ValidateLayoutVsAttachmentDescription(const debug_report_data *report_data, RenderPassCreateVersion rp_version,
3395 const VkImageLayout first_layout, const uint32_t attachment,
3396 const VkAttachmentDescription2KHR &attachment_description) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003397 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003398 const char *vuid;
3399 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3400
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003401 // Verify that initial loadOp on READ_ONLY attachments is not CLEAR
3402 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Shannon McPherson3ea65132018-12-05 10:37:39 -07003403 if (use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3404 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) ||
3405 (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL))) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003406 skip |=
Shannon McPherson3ea65132018-12-05 10:37:39 -07003407 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3408 "VUID-VkRenderPassCreateInfo2KHR-pAttachments-02522",
3409 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
3410 } else if (!use_rp2 && ((first_layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL) ||
3411 (first_layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL))) {
3412 skip |=
3413 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3414 "VUID-VkRenderPassCreateInfo-pAttachments-00836",
Dave Houltond8ed0212018-05-16 17:18:24 -06003415 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003416 }
3417 }
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003418 if (attachment_description.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3419 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003420 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01566";
Dave Houltond8ed0212018-05-16 17:18:24 -06003421 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003422 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 -06003423 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003424 }
3425 }
3426
3427 if (attachment_description.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
3428 if (first_layout == VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003429 vuid = use_rp2 ? kVUID_Core_DrawState_InvalidRenderpass : "VUID-VkRenderPassCreateInfo-pAttachments-01567";
Dave Houltond8ed0212018-05-16 17:18:24 -06003430 skip |=
Tobias Hectorbbb12282018-10-22 15:17:59 +01003431 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 -06003432 "Cannot clear attachment %d with invalid first layout %s.", attachment, string_VkImageLayout(first_layout));
Slawomir Cyganadf2b552018-04-24 17:18:26 +02003433 }
3434 }
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003435 return skip;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003436}
3437
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003438bool CoreChecks::ValidateLayouts(RenderPassCreateVersion rp_version, VkDevice device,
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003439 const VkRenderPassCreateInfo2KHR *pCreateInfo) {
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003440 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003441 const char *vuid;
3442 const bool use_rp2 = (rp_version == RENDER_PASS_VERSION_2);
3443 const char *const function_name = use_rp2 ? "vkCreateRenderPass2KHR()" : "vkCreateRenderPass()";
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003444
Jason Ekstranda1906302017-12-03 20:16:32 -08003445 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
3446 VkFormat format = pCreateInfo->pAttachments[i].format;
3447 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
3448 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
3449 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003450 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 -06003451 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003452 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout == "
3453 "VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3454 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3455 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003456 }
Dave Houltona9df0ce2018-02-07 10:51:23 -07003457 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003458 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 -06003459 kVUID_Core_DrawState_InvalidRenderpass,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003460 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD and initialLayout "
3461 "== VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you intended. Consider using "
3462 "VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the image truely is undefined at the start of the "
3463 "render pass.");
Jason Ekstranda1906302017-12-03 20:16:32 -08003464 }
3465 }
3466 }
3467
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003468 // Track when we're observing the first use of an attachment
3469 std::vector<bool> attach_first_use(pCreateInfo->attachmentCount, true);
3470 for (uint32_t i = 0; i < pCreateInfo->subpassCount; ++i) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003471 const VkSubpassDescription2KHR &subpass = pCreateInfo->pSubpasses[i];
Cort Stratton7547f772017-05-04 15:18:52 -07003472
3473 // Check input attachments first, so we can detect first-use-as-input for VU #00349
3474 for (uint32_t j = 0; j < subpass.inputAttachmentCount; ++j) {
3475 auto attach_index = subpass.pInputAttachments[j].attachment;
3476 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
Cort Stratton7547f772017-05-04 15:18:52 -07003477 switch (subpass.pInputAttachments[j].layout) {
3478 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3479 case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
3480 // These are ideal.
3481 break;
3482
3483 case VK_IMAGE_LAYOUT_GENERAL:
3484 // May not be optimal. TODO: reconsider this warning based on other constraints.
3485 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003486 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003487 "Layout for input attachment is GENERAL but should be READ_ONLY_OPTIMAL.");
3488 break;
3489
Tobias Hectorbbb12282018-10-22 15:17:59 +01003490 case VK_IMAGE_LAYOUT_UNDEFINED:
3491 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3492 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3493 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3494 "Layout for input attachment reference %u in subpass %u is %s but must be "
3495 "DEPTH_STENCIL_READ_ONLY, SHADER_READ_ONLY_OPTIMAL, or GENERAL.",
3496 j, i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3497 break;
3498
Graeme Leese668a9862018-10-08 10:40:02 +01003499 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3500 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003501 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Graeme Leese668a9862018-10-08 10:40:02 +01003502 break;
3503 } else {
3504 // Intentionally fall through to generic error message
3505 }
3506 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003507
Cort Stratton7547f772017-05-04 15:18:52 -07003508 default:
3509 // No other layouts are acceptable
3510 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 -06003511 kVUID_Core_DrawState_InvalidImageLayout,
Cort Stratton7547f772017-05-04 15:18:52 -07003512 "Layout for input attachment is %s but can only be READ_ONLY_OPTIMAL or GENERAL.",
3513 string_VkImageLayout(subpass.pInputAttachments[j].layout));
3514 }
3515
Cort Stratton7547f772017-05-04 15:18:52 -07003516 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003517 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pInputAttachments[j].layout,
3518 attach_index, pCreateInfo->pAttachments[attach_index]);
Cort Stratton7547f772017-05-04 15:18:52 -07003519
3520 bool used_as_depth =
3521 (subpass.pDepthStencilAttachment != NULL && subpass.pDepthStencilAttachment->attachment == attach_index);
3522 bool used_as_color = false;
3523 for (uint32_t k = 0; !used_as_depth && !used_as_color && k < subpass.colorAttachmentCount; ++k) {
3524 used_as_color = (subpass.pColorAttachments[k].attachment == attach_index);
3525 }
3526 if (!used_as_depth && !used_as_color &&
3527 pCreateInfo->pAttachments[attach_index].loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003528 vuid = use_rp2 ? "VUID-VkSubpassDescription2KHR-loadOp-03064" : "VUID-VkSubpassDescription-loadOp-00846";
3529 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3530 "%s: attachment %u is first used as an input attachment in subpass %u with loadOp=CLEAR.",
3531 function_name, attach_index, attach_index);
Cort Stratton7547f772017-05-04 15:18:52 -07003532 }
3533 }
3534 attach_first_use[attach_index] = false;
3535 }
Tobias Hectorbbb12282018-10-22 15:17:59 +01003536
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003537 for (uint32_t j = 0; j < subpass.colorAttachmentCount; ++j) {
3538 auto attach_index = subpass.pColorAttachments[j].attachment;
3539 if (attach_index == VK_ATTACHMENT_UNUSED) continue;
3540
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003541 // TODO: Need a way to validate shared presentable images here, currently just allowing
3542 // VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR
3543 // as an acceptable layout, but need to make sure shared presentable images ONLY use that layout
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003544 switch (subpass.pColorAttachments[j].layout) {
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003545 case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
Dave Houlton33c2d252017-06-09 17:08:32 -06003546 // This is ideal.
Tobin Ehlisbb03e5f2017-05-11 08:52:51 -06003547 case VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR:
3548 // TODO: See note above, just assuming that attachment is shared presentable and allowing this for now.
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003549 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003550
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003551 case VK_IMAGE_LAYOUT_GENERAL:
3552 // May not be optimal; TODO: reconsider this warning based on other constraints?
3553 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003554 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003555 "Layout for color attachment is GENERAL but should be COLOR_ATTACHMENT_OPTIMAL.");
3556 break;
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003557
Tobias Hectorbbb12282018-10-22 15:17:59 +01003558 case VK_IMAGE_LAYOUT_UNDEFINED:
3559 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3560 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3561 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3562 "Layout for color attachment reference %u in subpass %u is %s but should be "
3563 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3564 j, i, string_VkImageLayout(subpass.pColorAttachments[j].layout));
3565 break;
3566
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003567 default:
3568 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 -06003569 kVUID_Core_DrawState_InvalidImageLayout,
Mark Lobodzinski552e4402017-02-07 17:14:53 -07003570 "Layout for color attachment is %s but can only be COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
3571 string_VkImageLayout(subpass.pColorAttachments[j].layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003572 }
3573
John Zulauf4eee2692019-02-09 16:14:25 -07003574 if (subpass.pResolveAttachments && (subpass.pResolveAttachments[j].attachment != VK_ATTACHMENT_UNUSED) &&
3575 (subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_UNDEFINED ||
3576 subpass.pResolveAttachments[j].layout == VK_IMAGE_LAYOUT_PREINITIALIZED)) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003577 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3578 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 -07003579 "Layout for resolve attachment reference %u in subpass %u is %s but should be "
Tobias Hectorbbb12282018-10-22 15:17:59 +01003580 "COLOR_ATTACHMENT_OPTIMAL or GENERAL.",
John Zulauff0f8c2b2019-02-14 12:13:44 -07003581 j, i, string_VkImageLayout(subpass.pResolveAttachments[j].layout));
Tobias Hectorbbb12282018-10-22 15:17:59 +01003582 }
3583
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003584 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003585 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pColorAttachments[j].layout,
3586 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003587 }
3588 attach_first_use[attach_index] = false;
3589 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06003590
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003591 if (subpass.pDepthStencilAttachment && subpass.pDepthStencilAttachment->attachment != VK_ATTACHMENT_UNUSED) {
3592 switch (subpass.pDepthStencilAttachment->layout) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003593 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
3594 case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
3595 // These are ideal.
Lenny Komowb79f04a2017-09-18 17:07:00 -06003596 break;
Lenny Komowb79f04a2017-09-18 17:07:00 -06003597
Dave Houltona9df0ce2018-02-07 10:51:23 -07003598 case VK_IMAGE_LAYOUT_GENERAL:
3599 // May not be optimal; TODO: reconsider this warning based on other constraints? GENERAL can be better than
3600 // doing a bunch of transitions.
3601 skip |= log_msg(report_data, VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT,
Dave Houlton51653902018-06-22 17:32:13 -06003602 VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003603 "GENERAL layout for depth attachment may not give optimal performance.");
3604 break;
3605
Tobias Hectorbbb12282018-10-22 15:17:59 +01003606 case VK_IMAGE_LAYOUT_UNDEFINED:
3607 case VK_IMAGE_LAYOUT_PREINITIALIZED:
3608 vuid = use_rp2 ? "VUID-VkAttachmentReference2KHR-layout-03077" : "VUID-VkAttachmentReference-layout-00857";
3609 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0, vuid,
3610 "Layout for depth attachment reference in subpass %u is %s but must be a valid depth/stencil "
3611 "layout or GENERAL.",
3612 i, string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
3613 break;
3614
Dave Houltona9df0ce2018-02-07 10:51:23 -07003615 case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL_KHR:
3616 case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL_KHR:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003617 if (GetDeviceExtensions()->vk_khr_maintenance2) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07003618 break;
3619 } else {
3620 // Intentionally fall through to generic error message
3621 }
Tobin Ehlis648b1cf2018-04-13 15:24:13 -06003622 // fall through
Tobias Hectorbbb12282018-10-22 15:17:59 +01003623
Dave Houltona9df0ce2018-02-07 10:51:23 -07003624 default:
3625 // No other layouts are acceptable
3626 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 -06003627 kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003628 "Layout for depth attachment is %s but can only be DEPTH_STENCIL_ATTACHMENT_OPTIMAL, "
3629 "DEPTH_STENCIL_READ_ONLY_OPTIMAL or GENERAL.",
3630 string_VkImageLayout(subpass.pDepthStencilAttachment->layout));
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003631 }
3632
3633 auto attach_index = subpass.pDepthStencilAttachment->attachment;
3634 if (attach_first_use[attach_index]) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003635 skip |= ValidateLayoutVsAttachmentDescription(report_data, rp_version, subpass.pDepthStencilAttachment->layout,
3636 attach_index, pCreateInfo->pAttachments[attach_index]);
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003637 }
3638 attach_first_use[attach_index] = false;
3639 }
Mark Lobodzinskic679b032017-02-07 17:11:55 -07003640 }
3641 return skip;
3642}
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003643
3644// For any image objects that overlap mapped memory, verify that their layouts are PREINIT or GENERAL
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003645bool CoreChecks::ValidateMapImageLayouts(VkDevice device, DEVICE_MEM_INFO const *mem_info, VkDeviceSize offset,
3646 VkDeviceSize end_offset) {
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003647 bool skip = false;
3648 // Iterate over all bound image ranges and verify that for any that overlap the map ranges, the layouts are
3649 // VK_IMAGE_LAYOUT_PREINITIALIZED or VK_IMAGE_LAYOUT_GENERAL
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003650 // TODO : This can be optimized if we store ranges based on starting address and early exit when we pass our range
3651 for (auto image_handle : mem_info->bound_images) {
3652 auto img_it = mem_info->bound_ranges.find(image_handle);
3653 if (img_it != mem_info->bound_ranges.end()) {
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003654 if (RangesIntersect(&img_it->second, offset, end_offset)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003655 std::vector<VkImageLayout> layouts;
Mark Lobodzinskief4ab2e2019-03-07 13:23:36 -07003656 if (FindLayouts(VkImage(image_handle), layouts)) {
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003657 for (auto layout : layouts) {
3658 if (layout != VK_IMAGE_LAYOUT_PREINITIALIZED && layout != VK_IMAGE_LAYOUT_GENERAL) {
Petr Krausbc7f5442017-05-14 23:43:38 +02003659 skip |=
3660 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 -06003661 HandleToUint64(mem_info->mem), kVUID_Core_DrawState_InvalidImageLayout,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003662 "Mapping an image with layout %s can result in undefined behavior if this memory is used "
3663 "by the device. Only GENERAL or PREINITIALIZED should be used.",
Petr Krausbc7f5442017-05-14 23:43:38 +02003664 string_VkImageLayout(layout));
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003665 }
3666 }
3667 }
3668 }
3669 }
3670 }
Mark Lobodzinskiac23ec82017-02-07 17:21:55 -07003671 return skip;
Mark Lobodzinski08f14fa2017-02-07 17:20:06 -07003672}
Mark Lobodzinski96210742017-02-09 10:33:46 -07003673
3674// Helper function to validate correct usage bits set for buffers or images. Verify that (actual & desired) flags != 0 or, if strict
3675// is true, verify that (actual & desired) flags == desired
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003676bool CoreChecks::ValidateUsageFlags(const layer_data *device_data, VkFlags actual, VkFlags desired, VkBool32 strict,
3677 uint64_t obj_handle, VulkanObjectType obj_type, const char *msgCode, char const *func_name,
3678 char const *usage_str) {
Mark Lobodzinski96210742017-02-09 10:33:46 -07003679 bool correct_usage = false;
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003680 bool skip = false;
Mark Lobodzinski33826372017-04-13 11:10:11 -06003681 const char *type_str = object_string[obj_type];
Mark Lobodzinski96210742017-02-09 10:33:46 -07003682 if (strict) {
3683 correct_usage = ((actual & desired) == desired);
3684 } else {
3685 correct_usage = ((actual & desired) != 0);
3686 }
3687 if (!correct_usage) {
Dave Houlton8e9f6542018-05-18 12:18:22 -06003688 if (msgCode == kVUIDUndefined) {
Dave Houlton12befb92018-06-26 17:16:46 -06003689 // TODO: Fix callers with kVUIDUndefined to use correct validation checks.
Lockee9aeebf2019-03-03 23:50:08 -07003690 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle,
3691 kVUID_Core_MemTrack_InvalidUsageFlag,
3692 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3693 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003694 } else {
Lockee9aeebf2019-03-03 23:50:08 -07003695 skip = log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, get_debug_report_enum[obj_type], obj_handle, msgCode,
3696 "Invalid usage flag for %s %s used by %s. In this case, %s should have %s set during creation.",
3697 type_str, report_data->FormatHandle(obj_handle).c_str(), func_name, type_str, usage_str);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003698 }
3699 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003700 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003701}
3702
3703// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3704// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003705bool CoreChecks::ValidateImageUsageFlags(layer_data *device_data, IMAGE_STATE const *image_state, VkFlags desired, bool strict,
3706 const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003707 return ValidateUsageFlags(device_data, image_state->createInfo.usage, desired, strict, HandleToUint64(image_state->image),
3708 kVulkanObjectTypeImage, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003709}
3710
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003711bool CoreChecks::ValidateImageFormatFeatureFlags(layer_data *dev_data, IMAGE_STATE const *image_state, VkFormatFeatureFlags desired,
3712 char const *func_name, const char *linear_vuid, const char *optimal_vuid) {
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003713 VkFormatProperties format_properties = GetPDFormatProperties(image_state->createInfo.format);
Cort Stratton186b1a22018-05-01 20:18:06 -04003714 bool skip = false;
3715 if (image_state->createInfo.tiling == VK_IMAGE_TILING_LINEAR) {
3716 if ((format_properties.linearTilingFeatures & desired) != desired) {
Lockee9aeebf2019-03-03 23:50:08 -07003717 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3718 HandleToUint64(image_state->image), linear_vuid,
3719 "In %s, invalid linearTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
3720 format_properties.linearTilingFeatures, image_state->createInfo.format,
3721 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003722 }
3723 } else if (image_state->createInfo.tiling == VK_IMAGE_TILING_OPTIMAL) {
3724 if ((format_properties.optimalTilingFeatures & desired) != desired) {
3725 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
3726 HandleToUint64(image_state->image), optimal_vuid,
Lockee9aeebf2019-03-03 23:50:08 -07003727 "In %s, invalid optimalTilingFeatures (0x%08X) for format %u used by image %s.", func_name,
Cort Stratton186b1a22018-05-01 20:18:06 -04003728 format_properties.optimalTilingFeatures, image_state->createInfo.format,
Lockee9aeebf2019-03-03 23:50:08 -07003729 report_data->FormatHandle(image_state->image).c_str());
Cort Stratton186b1a22018-05-01 20:18:06 -04003730 }
3731 }
3732 return skip;
3733}
3734
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003735bool CoreChecks::ValidateImageSubresourceLayers(layer_data *dev_data, const GLOBAL_CB_NODE *cb_node,
3736 const VkImageSubresourceLayers *subresource_layers, char const *func_name,
3737 char const *member, uint32_t i) {
Cort Strattond619a302018-05-17 19:46:32 -07003738 bool skip = false;
Cort Strattond619a302018-05-17 19:46:32 -07003739 // layerCount must not be zero
3740 if (subresource_layers->layerCount == 0) {
3741 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3742 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-layerCount-01700",
3743 "In %s, pRegions[%u].%s.layerCount must not be zero.", func_name, i, member);
3744 }
3745 // aspectMask must not contain VK_IMAGE_ASPECT_METADATA_BIT
3746 if (subresource_layers->aspectMask & VK_IMAGE_ASPECT_METADATA_BIT) {
3747 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3748 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00168",
3749 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_METADATA_BIT set.", func_name, i, member);
3750 }
3751 // if aspectMask contains COLOR, it must not contain either DEPTH or STENCIL
3752 if ((subresource_layers->aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3753 (subresource_layers->aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
3754 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT,
3755 HandleToUint64(cb_node->commandBuffer), "VUID-VkImageSubresourceLayers-aspectMask-00167",
3756 "In %s, pRegions[%u].%s.aspectMask has VK_IMAGE_ASPECT_COLOR_BIT and either VK_IMAGE_ASPECT_DEPTH_BIT or "
3757 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3758 func_name, i, member);
3759 }
3760 return skip;
3761}
3762
Mark Lobodzinski96210742017-02-09 10:33:46 -07003763// Helper function to validate usage flags for buffers. For given buffer_state send actual vs. desired usage off to helper above
3764// where an error will be flagged if usage is not correct
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003765bool CoreChecks::ValidateBufferUsageFlags(const layer_data *device_data, BUFFER_STATE const *buffer_state, VkFlags desired,
3766 bool strict, const char *msgCode, char const *func_name, char const *usage_string) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06003767 return ValidateUsageFlags(device_data, buffer_state->createInfo.usage, desired, strict, HandleToUint64(buffer_state->buffer),
3768 kVulkanObjectTypeBuffer, msgCode, func_name, usage_string);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003769}
3770
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003771bool CoreChecks::ValidateBufferViewRange(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3772 const VkBufferViewCreateInfo *pCreateInfo, const VkPhysicalDeviceLimits *device_limits) {
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003773 bool skip = false;
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003774
3775 const VkDeviceSize &range = pCreateInfo->range;
3776 if (range != VK_WHOLE_SIZE) {
3777 // Range must be greater than 0
3778 if (range <= 0) {
3779 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3780 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00928",
3781 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3782 ") does not equal VK_WHOLE_SIZE, range must be greater than 0.",
3783 range);
3784 }
3785 // Range must be a multiple of the element size of format
Dave Houltona585d132019-01-18 13:05:42 -07003786 const size_t format_size = FormatElementSize(pCreateInfo->format);
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003787 if (range % format_size != 0) {
3788 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3789 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00929",
3790 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3791 ") does not equal VK_WHOLE_SIZE, range must be a multiple of the element size of the format "
3792 "(" PRINTF_SIZE_T_SPECIFIER ").",
3793 range, format_size);
3794 }
3795 // Range divided by the element size of format must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements
3796 if (range / format_size > device_limits->maxTexelBufferElements) {
3797 skip |=
3798 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3799 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-range-00930",
3800 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3801 ") does not equal VK_WHOLE_SIZE, range divided by the element size of the format (" PRINTF_SIZE_T_SPECIFIER
3802 ") must be less than or equal to VkPhysicalDeviceLimits::maxTexelBufferElements (%" PRIuLEAST32 ").",
3803 range, format_size, device_limits->maxTexelBufferElements);
3804 }
3805 // The sum of range and offset must be less than or equal to the size of buffer
3806 if (range + pCreateInfo->offset > buffer_state->createInfo.size) {
3807 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3808 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00931",
3809 "If VkBufferViewCreateInfo range (%" PRIuLEAST64
3810 ") does not equal VK_WHOLE_SIZE, the sum of offset (%" PRIuLEAST64
3811 ") and range must be less than or equal to the size of the buffer (%" PRIuLEAST64 ").",
3812 range, pCreateInfo->offset, buffer_state->createInfo.size);
3813 }
3814 }
3815 return skip;
3816}
3817
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003818bool CoreChecks::ValidateBufferViewBuffer(const layer_data *device_data, const BUFFER_STATE *buffer_state,
3819 const VkBufferViewCreateInfo *pCreateInfo) {
Shannon McPherson265383a2018-06-21 15:37:52 -06003820 bool skip = false;
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003821 const VkFormatProperties format_properties = GetPDFormatProperties(pCreateInfo->format);
Shannon McPherson265383a2018-06-21 15:37:52 -06003822 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT) &&
3823 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT)) {
3824 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3825 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00933",
3826 "If buffer was created with `usage` containing VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must "
3827 "be supported for uniform texel buffers");
3828 }
3829 if ((buffer_state->createInfo.usage & VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT) &&
3830 !(format_properties.bufferFeatures & VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT)) {
3831 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3832 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-buffer-00934",
3833 "If buffer was created with `usage` containing VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must "
3834 "be supported for storage texel buffers");
3835 }
3836 return skip;
3837}
3838
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003839bool CoreChecks::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3840 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003841 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3842
Mark Lobodzinski96210742017-02-09 10:33:46 -07003843 bool skip = false;
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003844
Dave Houltond8ed0212018-05-16 17:18:24 -06003845 // TODO: Add check for "VUID-vkCreateBuffer-flags-00911" (sparse address space accounting)
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003846
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003847 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_BINDING_BIT) && (!GetEnabledFeatures()->core.sparseBinding)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003848 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 -06003849 "VUID-VkBufferCreateInfo-flags-00915",
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003850 "vkCreateBuffer(): the sparseBinding device feature is disabled: Buffers cannot be created with the "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003851 "VK_BUFFER_CREATE_SPARSE_BINDING_BIT set.");
Mark Lobodzinski847b60c2017-03-13 09:32:45 -06003852 }
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003853
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003854 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT) && (!GetEnabledFeatures()->core.sparseResidencyBuffer)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003855 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 -06003856 "VUID-VkBufferCreateInfo-flags-00916",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003857 "vkCreateBuffer(): the sparseResidencyBuffer device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003858 "the VK_BUFFER_CREATE_SPARSE_RESIDENCY_BIT set.");
Mark Lobodzinskiaf355062017-03-13 09:35:01 -06003859 }
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003860
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003861 if ((pCreateInfo->flags & VK_BUFFER_CREATE_SPARSE_ALIASED_BIT) && (!GetEnabledFeatures()->core.sparseResidencyAliased)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06003862 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 -06003863 "VUID-VkBufferCreateInfo-flags-00917",
Dave Houltona9df0ce2018-02-07 10:51:23 -07003864 "vkCreateBuffer(): the sparseResidencyAliased device feature is disabled: Buffers cannot be created with "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003865 "the VK_BUFFER_CREATE_SPARSE_ALIASED_BIT set.");
Mark Lobodzinski035a4cf2017-03-13 09:45:07 -06003866 }
Jeff Bolz87697532019-01-11 22:54:00 -06003867
3868 auto chained_devaddr_struct = lvl_find_in_chain<VkBufferDeviceAddressCreateInfoEXT>(pCreateInfo->pNext);
3869 if (chained_devaddr_struct) {
3870 if (!(pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
3871 chained_devaddr_struct->deviceAddress != 0) {
3872 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3873 "VUID-VkBufferCreateInfo-deviceAddress-02604",
3874 "vkCreateBuffer(): Non-zero VkBufferDeviceAddressCreateInfoEXT::deviceAddress "
3875 "requires VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT.");
3876 }
3877 }
3878
3879 if ((pCreateInfo->flags & VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003880 !GetEnabledFeatures()->buffer_address.bufferDeviceAddressCaptureReplay) {
Jeff Bolz87697532019-01-11 22:54:00 -06003881 skip |= log_msg(
3882 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3883 "VUID-VkBufferCreateInfo-flags-02605",
3884 "vkCreateBuffer(): the bufferDeviceAddressCaptureReplay device feature is disabled: Buffers cannot be created with "
3885 "the VK_BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_EXT set.");
3886 }
3887
3888 if ((pCreateInfo->usage & VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT) &&
Mark Lobodzinski60e79032019-03-07 10:22:31 -07003889 !GetEnabledFeatures()->buffer_address.bufferDeviceAddress) {
Jeff Bolz87697532019-01-11 22:54:00 -06003890 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT, 0,
3891 "VUID-VkBufferCreateInfo-usage-02606",
3892 "vkCreateBuffer(): the bufferDeviceAddress device feature is disabled: Buffers cannot be created with "
3893 "the VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_EXT set.");
3894 }
3895
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003896 if (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT && pCreateInfo->pQueueFamilyIndices) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003897 skip |=
3898 ValidateQueueFamilies(device_data, pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices,
3899 "vkCreateBuffer", "pCreateInfo->pQueueFamilyIndices", "VUID-VkBufferCreateInfo-sharingMode-01419",
3900 "VUID-VkBufferCreateInfo-sharingMode-01419", false);
Mark Lobodzinski08ee03c2019-02-04 10:57:47 -07003901 }
3902
Mark Lobodzinski96210742017-02-09 10:33:46 -07003903 return skip;
3904}
3905
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003906void CoreChecks::PostCallRecordCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
3907 const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003908 if (result != VK_SUCCESS) return;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003909 // TODO : This doesn't create deep copy of pQueueFamilyIndices so need to fix that if/when we want that data to be valid
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003910 GetBufferMap()->insert(std::make_pair(*pBuffer, std::unique_ptr<BUFFER_STATE>(new BUFFER_STATE(*pBuffer, pCreateInfo))));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003911}
3912
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003913bool CoreChecks::PreCallValidateCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3914 const VkAllocationCallbacks *pAllocator, VkBufferView *pView) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07003915 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
3916
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003917 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07003918 BUFFER_STATE *buffer_state = GetBufferState(pCreateInfo->buffer);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003919 // If this isn't a sparse buffer, it needs to have memory backing it at CreateBufferView time
3920 if (buffer_state) {
Dave Houltond8ed0212018-05-16 17:18:24 -06003921 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCreateBufferView()",
3922 "VUID-VkBufferViewCreateInfo-buffer-00935");
Mark Lobodzinski96210742017-02-09 10:33:46 -07003923 // In order to create a valid buffer view, the buffer must have been created with at least one of the following flags:
3924 // UNIFORM_TEXEL_BUFFER_BIT or STORAGE_TEXEL_BUFFER_BIT
Dave Houltond8ed0212018-05-16 17:18:24 -06003925 skip |= ValidateBufferUsageFlags(device_data, buffer_state,
3926 VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, false,
3927 "VUID-VkBufferViewCreateInfo-buffer-00932", "vkCreateBufferView()",
3928 "VK_BUFFER_USAGE_[STORAGE|UNIFORM]_TEXEL_BUFFER_BIT");
Shannon McPherson883f6092018-06-14 13:15:25 -06003929
Shannon McPherson0eb84f62018-06-18 16:32:40 -06003930 // Buffer view offset must be less than the size of buffer
3931 if (pCreateInfo->offset >= buffer_state->createInfo.size) {
3932 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3933 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00925",
3934 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3935 ") must be less than the size of the buffer (%" PRIuLEAST64 ").",
3936 pCreateInfo->offset, buffer_state->createInfo.size);
3937 }
3938
Mark Lobodzinski5c048802019-03-07 10:47:31 -07003939 const VkPhysicalDeviceLimits *device_limits = &(GetPDProperties()->limits);
Shannon McPherson883f6092018-06-14 13:15:25 -06003940 // Buffer view offset must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment
3941 if ((pCreateInfo->offset % device_limits->minTexelBufferOffsetAlignment) != 0) {
3942 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT,
3943 HandleToUint64(buffer_state->buffer), "VUID-VkBufferViewCreateInfo-offset-00926",
3944 "VkBufferViewCreateInfo offset (%" PRIuLEAST64
3945 ") must be a multiple of VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment (%" PRIuLEAST64 ").",
3946 pCreateInfo->offset, device_limits->minTexelBufferOffsetAlignment);
3947 }
Shannon McPherson4c9505b2018-06-19 15:18:55 -06003948
3949 skip |= ValidateBufferViewRange(device_data, buffer_state, pCreateInfo, device_limits);
Shannon McPherson265383a2018-06-21 15:37:52 -06003950
3951 skip |= ValidateBufferViewBuffer(device_data, buffer_state, pCreateInfo);
Mark Lobodzinski96210742017-02-09 10:33:46 -07003952 }
Mark Lobodzinski95dbbe52017-02-09 10:40:41 -07003953 return skip;
Mark Lobodzinski96210742017-02-09 10:33:46 -07003954}
3955
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003956void CoreChecks::PostCallRecordCreateBufferView(VkDevice device, const VkBufferViewCreateInfo *pCreateInfo,
3957 const VkAllocationCallbacks *pAllocator, VkBufferView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07003958 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07003959 (*GetBufferViewMap())[*pView] = std::unique_ptr<BUFFER_VIEW_STATE>(new BUFFER_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinski96210742017-02-09 10:33:46 -07003960}
Mark Lobodzinski602de982017-02-09 11:01:33 -07003961
3962// For the given format verify that the aspect masks make sense
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07003963bool CoreChecks::ValidateImageAspectMask(const layer_data *device_data, VkImage image, VkFormat format,
3964 VkImageAspectFlags aspect_mask, const char *func_name, const char *vuid) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003965 bool skip = false;
Tobias Hectorbbb12282018-10-22 15:17:59 +01003966 VkDebugReportObjectTypeEXT objectType = VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT;
3967 if (image != VK_NULL_HANDLE) {
3968 objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
3969 }
3970
Dave Houlton1d2022c2017-03-29 11:43:58 -06003971 if (FormatIsColor(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003972 if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != VK_IMAGE_ASPECT_COLOR_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003973 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003974 "%s: Color image formats must have the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003975 } else if ((aspect_mask & VK_IMAGE_ASPECT_COLOR_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003976 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003977 "%s: Color image formats must have ONLY the VK_IMAGE_ASPECT_COLOR_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003978 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003979 } else if (FormatIsDepthAndStencil(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003980 if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003981 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houltona9df0ce2018-02-07 10:51:23 -07003982 "%s: Depth/stencil image formats must have at least one of VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003983 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3984 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003985 } else if ((aspect_mask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003986 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski602de982017-02-09 11:01:33 -07003987 "%s: Combination depth/stencil image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT and "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003988 "VK_IMAGE_ASPECT_STENCIL_BIT set.",
3989 func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003990 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003991 } else if (FormatIsDepthOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07003992 if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != VK_IMAGE_ASPECT_DEPTH_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003993 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003994 "%s: Depth-only image formats must have the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003995 } else if ((aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01003996 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06003997 "%s: Depth-only image formats can have only the VK_IMAGE_ASPECT_DEPTH_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07003998 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06003999 } else if (FormatIsStencilOnly(format)) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004000 if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != VK_IMAGE_ASPECT_STENCIL_BIT) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004001 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004002 "%s: Stencil-only image formats must have the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004003 } else if ((aspect_mask & VK_IMAGE_ASPECT_STENCIL_BIT) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004004 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004005 "%s: Stencil-only image formats can have only the VK_IMAGE_ASPECT_STENCIL_BIT set.", func_name);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004006 }
Dave Houlton501b15b2018-03-30 15:07:41 -06004007 } else if (FormatIsMultiplane(format)) {
4008 VkImageAspectFlags valid_flags = VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT | VK_IMAGE_ASPECT_PLANE_1_BIT;
4009 if (3 == FormatPlaneCount(format)) {
4010 valid_flags = valid_flags | VK_IMAGE_ASPECT_PLANE_2_BIT;
4011 }
4012 if ((aspect_mask & valid_flags) != aspect_mask) {
Tobias Hectorbbb12282018-10-22 15:17:59 +01004013 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, objectType, HandleToUint64(image), vuid,
Dave Houlton501b15b2018-03-30 15:07:41 -06004014 "%s: Multi-plane image formats may have only VK_IMAGE_ASPECT_COLOR_BIT or VK_IMAGE_ASPECT_PLANE_n_BITs "
4015 "set, where n = [0, 1, 2].",
4016 func_name);
4017 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004018 }
4019 return skip;
4020}
4021
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004022bool CoreChecks::ValidateImageSubresourceRange(const layer_data *device_data, const uint32_t image_mip_count,
4023 const uint32_t image_layer_count, const VkImageSubresourceRange &subresourceRange,
4024 const char *cmd_name, const char *param_name, const char *image_layer_count_var_name,
4025 const uint64_t image_handle, SubresourceRangeErrorCodes errorCodes) {
Mark Lobodzinski602de982017-02-09 11:01:33 -07004026 bool skip = false;
Petr Kraus4d718682017-05-18 03:38:41 +02004027
4028 // Validate mip levels
Petr Krausffa94af2017-08-08 21:46:02 +02004029 if (subresourceRange.baseMipLevel >= image_mip_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004030 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 -06004031 errorCodes.base_mip_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004032 "%s: %s.baseMipLevel (= %" PRIu32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004033 ") is greater or equal to the mip level count of the image (i.e. greater or equal to %" PRIu32 ").",
4034 cmd_name, param_name, subresourceRange.baseMipLevel, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004035 }
Petr Kraus4d718682017-05-18 03:38:41 +02004036
Petr Krausffa94af2017-08-08 21:46:02 +02004037 if (subresourceRange.levelCount != VK_REMAINING_MIP_LEVELS) {
4038 if (subresourceRange.levelCount == 0) {
4039 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 -06004040 errorCodes.mip_count_err, "%s: %s.levelCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004041 } else {
4042 const uint64_t necessary_mip_count = uint64_t{subresourceRange.baseMipLevel} + uint64_t{subresourceRange.levelCount};
Petr Kraus4d718682017-05-18 03:38:41 +02004043
Petr Krausffa94af2017-08-08 21:46:02 +02004044 if (necessary_mip_count > image_mip_count) {
4045 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 -06004046 errorCodes.mip_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004047 "%s: %s.baseMipLevel + .levelCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004048 ") is greater than the mip level count of the image (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004049 cmd_name, param_name, subresourceRange.baseMipLevel, subresourceRange.levelCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004050 necessary_mip_count, image_mip_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004051 }
Petr Kraus4d718682017-05-18 03:38:41 +02004052 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004053 }
Petr Kraus4d718682017-05-18 03:38:41 +02004054
4055 // Validate array layers
Petr Krausffa94af2017-08-08 21:46:02 +02004056 if (subresourceRange.baseArrayLayer >= image_layer_count) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004057 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 -06004058 errorCodes.base_layer_err,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004059 "%s: %s.baseArrayLayer (= %" PRIu32
4060 ") is greater or equal to the %s of the image when it was created (i.e. greater or equal to %" PRIu32 ").",
4061 cmd_name, param_name, subresourceRange.baseArrayLayer, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004062 }
Petr Kraus4d718682017-05-18 03:38:41 +02004063
Petr Krausffa94af2017-08-08 21:46:02 +02004064 if (subresourceRange.layerCount != VK_REMAINING_ARRAY_LAYERS) {
4065 if (subresourceRange.layerCount == 0) {
4066 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 -06004067 errorCodes.layer_count_err, "%s: %s.layerCount is 0.", cmd_name, param_name);
Petr Krausffa94af2017-08-08 21:46:02 +02004068 } else {
4069 const uint64_t necessary_layer_count =
4070 uint64_t{subresourceRange.baseArrayLayer} + uint64_t{subresourceRange.layerCount};
Petr Kraus8423f152017-05-26 01:20:04 +02004071
Petr Krausffa94af2017-08-08 21:46:02 +02004072 if (necessary_layer_count > image_layer_count) {
4073 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 -06004074 errorCodes.layer_count_err,
Petr Krausffa94af2017-08-08 21:46:02 +02004075 "%s: %s.baseArrayLayer + .layerCount (= %" PRIu32 " + %" PRIu32 " = %" PRIu64
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004076 ") is greater than the %s of the image when it was created (i.e. greater than %" PRIu32 ").",
Petr Krausffa94af2017-08-08 21:46:02 +02004077 cmd_name, param_name, subresourceRange.baseArrayLayer, subresourceRange.layerCount,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004078 necessary_layer_count, image_layer_count_var_name, image_layer_count);
Petr Krausffa94af2017-08-08 21:46:02 +02004079 }
Petr Kraus4d718682017-05-18 03:38:41 +02004080 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004081 }
Petr Kraus4d718682017-05-18 03:38:41 +02004082
Mark Lobodzinski602de982017-02-09 11:01:33 -07004083 return skip;
4084}
4085
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004086bool CoreChecks::ValidateCreateImageViewSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4087 bool is_imageview_2d_type,
4088 const VkImageSubresourceRange &subresourceRange) {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004089 bool is_khr_maintenance1 = GetDeviceExtensions()->vk_khr_maintenance1;
Petr Krausffa94af2017-08-08 21:46:02 +02004090 bool is_image_slicable = image_state->createInfo.imageType == VK_IMAGE_TYPE_3D &&
4091 (image_state->createInfo.flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR);
4092 bool is_3D_to_2D_map = is_khr_maintenance1 && is_image_slicable && is_imageview_2d_type;
4093
4094 const auto image_layer_count = is_3D_to_2D_map ? image_state->createInfo.extent.depth : image_state->createInfo.arrayLayers;
4095 const auto image_layer_count_var_name = is_3D_to_2D_map ? "extent.depth" : "arrayLayers";
4096
4097 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004098 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageViewCreateInfo-subresourceRange-01478";
4099 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageViewCreateInfo-subresourceRange-01718";
4100 subresourceRangeErrorCodes.base_layer_err = is_khr_maintenance1 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-image-01484"
4101 : "VUID-VkImageViewCreateInfo-image-01482")
4102 : "VUID-VkImageViewCreateInfo-subresourceRange-01480";
4103 subresourceRangeErrorCodes.layer_count_err = is_khr_maintenance1
4104 ? (is_3D_to_2D_map ? "VUID-VkImageViewCreateInfo-subresourceRange-01485"
4105 : "VUID-VkImageViewCreateInfo-subresourceRange-01483")
4106 : "VUID-VkImageViewCreateInfo-subresourceRange-01719";
Petr Krausffa94af2017-08-08 21:46:02 +02004107
4108 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_layer_count, subresourceRange,
4109 "vkCreateImageView", "pCreateInfo->subresourceRange", image_layer_count_var_name,
4110 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4111}
4112
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004113bool CoreChecks::ValidateCmdClearColorSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4114 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004115 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004116 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearColorImage-baseMipLevel-01470";
4117 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearColorImage-pRanges-01692";
4118 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearColorImage-baseArrayLayer-01472";
4119 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearColorImage-pRanges-01693";
Petr Krausffa94af2017-08-08 21:46:02 +02004120
4121 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4122 subresourceRange, "vkCmdClearColorImage", param_name, "arrayLayers",
4123 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4124}
4125
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004126bool CoreChecks::ValidateCmdClearDepthSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4127 const VkImageSubresourceRange &subresourceRange, const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004128 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004129 subresourceRangeErrorCodes.base_mip_err = "VUID-vkCmdClearDepthStencilImage-baseMipLevel-01474";
4130 subresourceRangeErrorCodes.mip_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01694";
4131 subresourceRangeErrorCodes.base_layer_err = "VUID-vkCmdClearDepthStencilImage-baseArrayLayer-01476";
4132 subresourceRangeErrorCodes.layer_count_err = "VUID-vkCmdClearDepthStencilImage-pRanges-01695";
Petr Krausffa94af2017-08-08 21:46:02 +02004133
4134 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4135 subresourceRange, "vkCmdClearDepthStencilImage", param_name, "arrayLayers",
4136 HandleToUint64(image_state->image), subresourceRangeErrorCodes);
4137}
4138
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004139bool CoreChecks::ValidateImageBarrierSubresourceRange(const layer_data *device_data, const IMAGE_STATE *image_state,
4140 const VkImageSubresourceRange &subresourceRange, const char *cmd_name,
4141 const char *param_name) {
Petr Krausffa94af2017-08-08 21:46:02 +02004142 SubresourceRangeErrorCodes subresourceRangeErrorCodes = {};
Dave Houltond8ed0212018-05-16 17:18:24 -06004143 subresourceRangeErrorCodes.base_mip_err = "VUID-VkImageMemoryBarrier-subresourceRange-01486";
4144 subresourceRangeErrorCodes.mip_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01724";
4145 subresourceRangeErrorCodes.base_layer_err = "VUID-VkImageMemoryBarrier-subresourceRange-01488";
4146 subresourceRangeErrorCodes.layer_count_err = "VUID-VkImageMemoryBarrier-subresourceRange-01725";
Petr Krausffa94af2017-08-08 21:46:02 +02004147
4148 return ValidateImageSubresourceRange(device_data, image_state->createInfo.mipLevels, image_state->createInfo.arrayLayers,
4149 subresourceRange, cmd_name, param_name, "arrayLayers", HandleToUint64(image_state->image),
4150 subresourceRangeErrorCodes);
4151}
4152
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004153bool CoreChecks::PreCallValidateCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4154 const VkAllocationCallbacks *pAllocator, VkImageView *pView) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004155 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004156 bool skip = false;
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004157 IMAGE_STATE *image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004158 if (image_state) {
4159 skip |= ValidateImageUsageFlags(
4160 device_data, image_state,
4161 VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT |
Dave Houlton142c4cb2018-10-17 15:04:41 -06004162 VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT |
4163 VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV,
Dave Houlton8e9f6542018-05-18 12:18:22 -06004164 false, kVUIDUndefined, "vkCreateImageView()",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004165 "VK_IMAGE_USAGE_[SAMPLED|STORAGE|COLOR_ATTACHMENT|DEPTH_STENCIL_ATTACHMENT|INPUT_ATTACHMENT|SHADING_RATE_IMAGE]_BIT");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004166 // If this isn't a sparse image, it needs to have memory backing it at CreateImageView time
Dave Houltond8ed0212018-05-16 17:18:24 -06004167 skip |=
4168 ValidateMemoryIsBoundToImage(device_data, image_state, "vkCreateImageView()", "VUID-VkImageViewCreateInfo-image-01020");
Mark Lobodzinski602de982017-02-09 11:01:33 -07004169 // Checks imported from image layer
Petr Krausffa94af2017-08-08 21:46:02 +02004170 skip |= ValidateCreateImageViewSubresourceRange(
4171 device_data, image_state,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004172 pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D || pCreateInfo->viewType == VK_IMAGE_VIEW_TYPE_2D_ARRAY,
4173 pCreateInfo->subresourceRange);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004174
4175 VkImageCreateFlags image_flags = image_state->createInfo.flags;
4176 VkFormat image_format = image_state->createInfo.format;
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004177 VkImageUsageFlags image_usage = image_state->createInfo.usage;
4178 VkImageTiling image_tiling = image_state->createInfo.tiling;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004179 VkFormat view_format = pCreateInfo->format;
4180 VkImageAspectFlags aspect_mask = pCreateInfo->subresourceRange.aspectMask;
Jeremy Kniager846ab732017-07-10 13:12:04 -06004181 VkImageType image_type = image_state->createInfo.imageType;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004182 VkImageViewType view_type = pCreateInfo->viewType;
Mark Lobodzinski602de982017-02-09 11:01:33 -07004183
Dave Houltonbd2e2622018-04-10 16:41:14 -06004184 // If there's a chained VkImageViewUsageCreateInfo struct, modify image_usage to match
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004185 auto chained_ivuci_struct = lvl_find_in_chain<VkImageViewUsageCreateInfoKHR>(pCreateInfo->pNext);
Dave Houltonbd2e2622018-04-10 16:41:14 -06004186 if (chained_ivuci_struct) {
4187 if (chained_ivuci_struct->usage & ~image_usage) {
4188 std::stringstream ss;
4189 ss << "vkCreateImageView(): Chained VkImageViewUsageCreateInfo usage field (0x" << std::hex
Dave Houlton0f3795b2018-04-13 15:04:35 -06004190 << chained_ivuci_struct->usage << ") must not include flags not present in underlying image's usage (0x"
Dave Houltonbd2e2622018-04-10 16:41:14 -06004191 << image_usage << ").";
Mark Young9d1ac312018-05-21 16:28:27 -06004192 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004193 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewUsageCreateInfo-usage-01587", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004194 ss.str().c_str());
Dave Houltonbd2e2622018-04-10 16:41:14 -06004195 }
4196
4197 image_usage = chained_ivuci_struct->usage;
4198 }
4199
Dave Houlton6f5f20a2018-05-04 12:37:44 -06004200 // Validate VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT state, if view/image formats differ
4201 if ((image_flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT) && (image_format != view_format)) {
Dave Houltonc7988072018-04-16 11:46:56 -06004202 if (FormatIsMultiplane(image_format)) {
4203 // View format must match the multiplane compatible format
4204 uint32_t plane = 3; // invalid
4205 switch (aspect_mask) {
4206 case VK_IMAGE_ASPECT_PLANE_0_BIT:
4207 plane = 0;
4208 break;
4209 case VK_IMAGE_ASPECT_PLANE_1_BIT:
4210 plane = 1;
4211 break;
4212 case VK_IMAGE_ASPECT_PLANE_2_BIT:
4213 plane = 2;
4214 break;
4215 default:
4216 break;
4217 }
4218
4219 VkFormat compat_format = FindMultiplaneCompatibleFormat(image_format, plane);
4220 if (view_format != compat_format) {
Lenny Komowb79f04a2017-09-18 17:07:00 -06004221 std::stringstream ss;
4222 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004223 << " is not compatible with plane " << plane << " of underlying image format "
4224 << string_VkFormat(image_format) << ", must be " << string_VkFormat(compat_format) << ".";
Mark Young9d1ac312018-05-21 16:28:27 -06004225 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004226 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01586", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004227 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004228 }
4229 } else {
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004230 if ((!GetDeviceExtensions()->vk_khr_maintenance2 ||
Dave Houltonc7988072018-04-16 11:46:56 -06004231 !(image_flags & VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT_KHR))) {
4232 // Format MUST be compatible (in the same format compatibility class) as the format the image was created with
4233 if (FormatCompatibilityClass(image_format) != FormatCompatibilityClass(view_format)) {
4234 std::stringstream ss;
4235 ss << "vkCreateImageView(): ImageView format " << string_VkFormat(view_format)
Lockee9aeebf2019-03-03 23:50:08 -07004236 << " is not in the same format compatibility class as image ("
4237 << report_data->FormatHandle(pCreateInfo->image).c_str() << ") format " << string_VkFormat(image_format)
Dave Houltonc7988072018-04-16 11:46:56 -06004238 << ". Images created with the VK_IMAGE_CREATE_MUTABLE_FORMAT BIT "
4239 << "can support ImageViews with differing formats but they must be in the same compatibility class.";
Mark Young9d1ac312018-05-21 16:28:27 -06004240 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 -07004241 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01018", "%s",
Mark Young9d1ac312018-05-21 16:28:27 -06004242 ss.str().c_str());
Dave Houltonc7988072018-04-16 11:46:56 -06004243 }
Lenny Komowb79f04a2017-09-18 17:07:00 -06004244 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004245 }
4246 } else {
4247 // Format MUST be IDENTICAL to the format the image was created with
4248 if (image_format != view_format) {
4249 std::stringstream ss;
4250 ss << "vkCreateImageView() format " << string_VkFormat(view_format) << " differs from image "
Lockee9aeebf2019-03-03 23:50:08 -07004251 << report_data->FormatHandle(pCreateInfo->image).c_str() << " format " << string_VkFormat(image_format)
Mark Lobodzinski602de982017-02-09 11:01:33 -07004252 << ". Formats MUST be IDENTICAL unless VK_IMAGE_CREATE_MUTABLE_FORMAT BIT was set on image creation.";
Mark Young9d1ac312018-05-21 16:28:27 -06004253 skip |=
4254 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004255 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01019", "%s", ss.str().c_str());
Mark Lobodzinski602de982017-02-09 11:01:33 -07004256 }
4257 }
4258
4259 // Validate correct image aspect bits for desired formats and format consistency
4260 skip |= ValidateImageAspectMask(device_data, image_state->image, image_format, aspect_mask, "vkCreateImageView()");
Jeremy Kniager846ab732017-07-10 13:12:04 -06004261
4262 switch (image_type) {
4263 case VK_IMAGE_TYPE_1D:
4264 if (view_type != VK_IMAGE_VIEW_TYPE_1D && view_type != VK_IMAGE_VIEW_TYPE_1D_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004265 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 -07004266 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004267 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4268 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004269 }
4270 break;
4271 case VK_IMAGE_TYPE_2D:
4272 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4273 if ((view_type == VK_IMAGE_VIEW_TYPE_CUBE || view_type == VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) &&
4274 !(image_flags & VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT)) {
Mark Young9d1ac312018-05-21 16:28:27 -06004275 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004276 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01003",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004277 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4278 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004279 } else if (view_type != VK_IMAGE_VIEW_TYPE_CUBE && view_type != VK_IMAGE_VIEW_TYPE_CUBE_ARRAY) {
Mark Young9d1ac312018-05-21 16:28:27 -06004280 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004281 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004282 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4283 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004284 }
4285 }
4286 break;
4287 case VK_IMAGE_TYPE_3D:
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004288 if (GetDeviceExtensions()->vk_khr_maintenance1) {
Jeremy Kniager846ab732017-07-10 13:12:04 -06004289 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
4290 if ((view_type == VK_IMAGE_VIEW_TYPE_2D || view_type == VK_IMAGE_VIEW_TYPE_2D_ARRAY)) {
4291 if (!(image_flags & VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT_KHR)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004292 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004293 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004294 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-01005",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004295 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4296 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004297 } else if ((image_flags & (VK_IMAGE_CREATE_SPARSE_BINDING_BIT | VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT |
4298 VK_IMAGE_CREATE_SPARSE_ALIASED_BIT))) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004299 skip |=
Mark Young9d1ac312018-05-21 16:28:27 -06004300 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004301 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004302 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s "
4303 "when the VK_IMAGE_CREATE_SPARSE_BINDING_BIT, VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004304 "VK_IMAGE_CREATE_SPARSE_ALIASED_BIT flags are enabled.",
4305 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004306 }
4307 } else {
Mark Young9d1ac312018-05-21 16:28:27 -06004308 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 -07004309 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004310 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4311 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004312 }
4313 }
4314 } else {
4315 if (view_type != VK_IMAGE_VIEW_TYPE_3D) {
Mark Young9d1ac312018-05-21 16:28:27 -06004316 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 -07004317 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-subResourceRange-01021",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004318 "vkCreateImageView(): pCreateInfo->viewType %s is not compatible with image type %s.",
4319 string_VkImageViewType(view_type), string_VkImageType(image_type));
Jeremy Kniager846ab732017-07-10 13:12:04 -06004320 }
4321 }
4322 break;
4323 default:
4324 break;
4325 }
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004326
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004327 // External format checks needed when VK_ANDROID_external_memory_android_hardware_buffer enabled
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004328 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004329 skip |= ValidateCreateImageViewANDROID(device_data, pCreateInfo);
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004330 }
4331
Mark Lobodzinski5c048802019-03-07 10:47:31 -07004332 VkFormatProperties format_properties = GetPDFormatProperties(view_format);
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004333 VkFormatFeatureFlags tiling_features = (image_tiling & VK_IMAGE_TILING_LINEAR) ? format_properties.linearTilingFeatures
4334 : format_properties.optimalTilingFeatures;
4335
4336 if (tiling_features == 0) {
4337 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004338 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-None-02273",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004339 "vkCreateImageView(): pCreateInfo->format %s with tiling %s has no supported format features on this "
4340 "physical device.",
4341 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4342 } else if ((image_usage & VK_IMAGE_USAGE_SAMPLED_BIT) && !(tiling_features & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
4343 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 -07004344 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02274",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004345 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4346 "VK_IMAGE_USAGE_SAMPLED_BIT.",
4347 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4348 } else if ((image_usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(tiling_features & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
4349 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 -07004350 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02275",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004351 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4352 "VK_IMAGE_USAGE_STORAGE_BIT.",
4353 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4354 } else if ((image_usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) &&
4355 !(tiling_features & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
4356 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 -07004357 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02276",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004358 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4359 "VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT.",
4360 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
4361 } else if ((image_usage & VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT) &&
4362 !(tiling_features & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
4363 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 -07004364 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-usage-02277",
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004365 "vkCreateImageView(): pCreateInfo->format %s with tiling %s does not support usage that includes "
4366 "VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT.",
4367 string_VkFormat(view_format), string_VkImageTiling(image_tiling));
Jeremy Kniagercef491c2017-07-18 11:10:28 -06004368 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06004369
Jeff Bolz9af91c52018-09-01 21:53:57 -05004370 if (image_usage & VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV) {
4371 if (view_type != VK_IMAGE_VIEW_TYPE_2D && view_type != VK_IMAGE_VIEW_TYPE_2D_ARRAY) {
4372 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 -07004373 HandleToUint64(pCreateInfo->image), "VUID-VkImageViewCreateInfo-image-02086",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004374 "vkCreateImageView() If image was created with usage containing "
4375 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, viewType must be "
4376 "VK_IMAGE_VIEW_TYPE_2D or VK_IMAGE_VIEW_TYPE_2D_ARRAY.");
4377 }
4378 if (view_format != VK_FORMAT_R8_UINT) {
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-image-02087",
Jeff Bolz9af91c52018-09-01 21:53:57 -05004381 "vkCreateImageView() If image was created with usage containing "
4382 "VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV, format must be VK_FORMAT_R8_UINT.");
4383 }
4384 }
Mark Lobodzinski602de982017-02-09 11:01:33 -07004385 }
4386 return skip;
4387}
4388
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004389void CoreChecks::PostCallRecordCreateImageView(VkDevice device, const VkImageViewCreateInfo *pCreateInfo,
4390 const VkAllocationCallbacks *pAllocator, VkImageView *pView, VkResult result) {
Mark Lobodzinski701507e2019-01-18 14:31:53 -07004391 if (result != VK_SUCCESS) return;
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004392 auto image_view_map = GetImageViewMap();
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004393 (*image_view_map)[*pView] = std::unique_ptr<IMAGE_VIEW_STATE>(new IMAGE_VIEW_STATE(*pView, pCreateInfo));
Mark Lobodzinskiefd933b2017-02-10 12:09:23 -07004394
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004395 auto image_state = GetImageState(pCreateInfo->image);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004396 auto &sub_res_range = (*image_view_map)[*pView].get()->create_info.subresourceRange;
Mark Lobodzinski903e5ff2017-03-23 09:43:35 -06004397 sub_res_range.levelCount = ResolveRemainingLevels(&sub_res_range, image_state->createInfo.mipLevels);
4398 sub_res_range.layerCount = ResolveRemainingLayers(&sub_res_range, image_state->createInfo.arrayLayers);
Mark Lobodzinski602de982017-02-09 11:01:33 -07004399}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004400
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004401bool CoreChecks::PreCallValidateCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4402 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004403 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004404 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004405 auto src_buffer_state = GetBufferState(srcBuffer);
4406 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004407
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004408 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004409 skip |=
4410 ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-srcBuffer-00119");
4411 skip |=
4412 ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-dstBuffer-00121");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004413 // Validate that SRC & DST buffers have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004414 skip |=
4415 ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
4416 "VUID-vkCmdCopyBuffer-srcBuffer-00118", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4417 skip |=
4418 ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4419 "VUID-vkCmdCopyBuffer-dstBuffer-00120", "vkCmdCopyBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004420 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdCopyBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004421 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4422 "VUID-vkCmdCopyBuffer-commandBuffer-cmdpool");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004423 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFER, "vkCmdCopyBuffer()");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004424 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBuffer()", "VUID-vkCmdCopyBuffer-renderpass");
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004425 return skip;
4426}
Mark Lobodzinskiab9be282017-02-09 12:01:27 -07004427
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004428void CoreChecks::PreCallRecordCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
4429 uint32_t regionCount, const VkBufferCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004430 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004431 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004432 auto src_buffer_state = GetBufferState(srcBuffer);
4433 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004434
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004435 // Update bindings between buffers and cmd buffer
4436 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
4437 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinski680421d2017-02-09 13:06:56 -07004438}
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004439
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004440bool CoreChecks::ValidateIdleBuffer(layer_data *device_data, VkBuffer buffer) {
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004441 bool skip = false;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004442 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004443 if (!buffer_state) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004444 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 -07004445 kVUID_Core_DrawState_DoubleDestroy, "Cannot free buffer %s that has not been allocated.",
4446 report_data->FormatHandle(buffer).c_str());
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004447 } else {
4448 if (buffer_state->in_use.load()) {
Petr Krausbc7f5442017-05-14 23:43:38 +02004449 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 -06004450 HandleToUint64(buffer), "VUID-vkDestroyBuffer-buffer-00922",
Lockee9aeebf2019-03-03 23:50:08 -07004451 "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 -07004452 }
4453 }
4454 return skip;
4455}
4456
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004457bool CoreChecks::PreCallValidateDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004458 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004459 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004460 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4461
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004462 bool skip = false;
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004463 if (image_view_state) {
4464 skip |= ValidateObjectNotInUse(device_data, image_view_state, obj_struct, "vkDestroyImageView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004465 "VUID-vkDestroyImageView-imageView-01026");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004466 }
4467 return skip;
4468}
4469
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004470void CoreChecks::PreCallRecordDestroyImageView(VkDevice device, VkImageView imageView, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004471 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinskia3a230b2019-03-06 15:35:13 -07004472 IMAGE_VIEW_STATE *image_view_state = GetImageViewState(imageView);
Mark Lobodzinskic8c8d0d2019-01-10 12:55:26 -07004473 if (!image_view_state) return;
4474 VK_OBJECT obj_struct = {HandleToUint64(imageView), kVulkanObjectTypeImageView};
4475
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004476 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004477 InvalidateCommandBuffers(device_data, image_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004478 (*GetImageViewMap()).erase(imageView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004479}
4480
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004481bool CoreChecks::PreCallValidateDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004482 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004483 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004484
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004485 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004486 if (buffer_state) {
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004487 skip |= ValidateIdleBuffer(device_data, buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004488 }
4489 return skip;
4490}
4491
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004492void CoreChecks::PreCallRecordDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004493 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
4494 if (!buffer) return;
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004495 auto buffer_state = GetBufferState(buffer);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004496 VK_OBJECT obj_struct = {HandleToUint64(buffer), kVulkanObjectTypeBuffer};
4497
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004498 InvalidateCommandBuffers(device_data, buffer_state->cb_bindings, obj_struct);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004499 for (auto mem_binding : buffer_state->GetBoundMemory()) {
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004500 auto mem_info = GetMemObjInfo(mem_binding);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004501 if (mem_info) {
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004502 RemoveBufferMemoryRange(HandleToUint64(buffer), mem_info);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004503 }
4504 }
Mark Lobodzinski97f83f72019-03-07 10:01:52 -07004505 ClearMemoryObjectBindings(HandleToUint64(buffer), kVulkanObjectTypeBuffer);
John Zulauf6b4aae82018-05-09 13:03:36 -06004506 EraseQFOReleaseBarriers<VkBufferMemoryBarrier>(device_data, buffer);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004507 GetBufferMap()->erase(buffer_state->buffer);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004508}
4509
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004510bool CoreChecks::PreCallValidateDestroyBufferView(VkDevice device, VkBufferView bufferView,
4511 const VkAllocationCallbacks *pAllocator) {
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004512 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004513 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004514 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004515 bool skip = false;
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004516 if (buffer_view_state) {
4517 skip |= ValidateObjectNotInUse(device_data, buffer_view_state, obj_struct, "vkDestroyBufferView",
Dave Houltond8ed0212018-05-16 17:18:24 -06004518 "VUID-vkDestroyBufferView-bufferView-00936");
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004519 }
4520 return skip;
4521}
4522
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004523void CoreChecks::PreCallRecordDestroyBufferView(VkDevice device, VkBufferView bufferView, 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 (!bufferView) return;
Mark Lobodzinski31aa9b02019-03-06 11:51:37 -07004526 auto buffer_view_state = GetBufferViewState(bufferView);
Mark Lobodzinskidd995d22019-01-11 11:05:15 -07004527 VK_OBJECT obj_struct = {HandleToUint64(bufferView), kVulkanObjectTypeBufferView};
4528
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004529 // Any bound cmd buffers are now invalid
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004530 InvalidateCommandBuffers(device_data, buffer_view_state->cb_bindings, obj_struct);
Mark Lobodzinski1170cf22019-03-07 11:08:21 -07004531 GetBufferViewMap()->erase(bufferView);
Mark Lobodzinski306441e2017-02-10 13:48:38 -07004532}
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004533
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004534bool CoreChecks::PreCallValidateCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4535 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004536 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004537 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004538 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004539 bool skip = false;
Dave Houltond8ed0212018-05-16 17:18:24 -06004540 skip |= ValidateMemoryIsBoundToBuffer(device_data, buffer_state, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-dstBuffer-00031");
Mike Schuchardt9c582402017-02-23 15:57:37 -07004541 skip |= ValidateCmdQueueFlags(device_data, cb_node, "vkCmdFillBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004542 VK_QUEUE_TRANSFER_BIT | VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT,
4543 "VUID-vkCmdFillBuffer-commandBuffer-cmdpool");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004544 skip |= ValidateCmd(device_data, cb_node, CMD_FILLBUFFER, "vkCmdFillBuffer()");
4545 // Validate that DST buffer has correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004546 skip |=
4547 ValidateBufferUsageFlags(device_data, buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
4548 "VUID-vkCmdFillBuffer-dstBuffer-00029", "vkCmdFillBuffer()", "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004549 skip |= InsideRenderPass(device_data, cb_node, "vkCmdFillBuffer()", "VUID-vkCmdFillBuffer-renderpass");
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004550 return skip;
4551}
4552
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004553void CoreChecks::PreCallRecordCmdFillBuffer(VkCommandBuffer commandBuffer, VkBuffer dstBuffer, VkDeviceSize dstOffset,
4554 VkDeviceSize size, uint32_t data) {
Mark Lobodzinski9a075c22019-01-10 14:30:39 -07004555 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004556 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004557 auto buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004558 // Update bindings between buffer and cmd buffer
4559 AddCommandBufferBindingBuffer(device_data, cb_node, buffer_state);
Mark Lobodzinskidf0acbf2017-02-10 14:01:27 -07004560}
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004561
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004562bool CoreChecks::ValidateBufferImageCopyData(const debug_report_data *report_data, uint32_t regionCount,
4563 const VkBufferImageCopy *pRegions, IMAGE_STATE *image_state, const char *function) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004564 bool skip = false;
4565
4566 for (uint32_t i = 0; i < regionCount; i++) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004567 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) {
4568 if ((pRegions[i].imageOffset.y != 0) || (pRegions[i].imageExtent.height != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004569 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 -06004570 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00199",
Dave Houltona9df0ce2018-02-07 10:51:23 -07004571 "%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 -06004572 "and 1, respectively.",
4573 function, i, pRegions[i].imageOffset.y, pRegions[i].imageExtent.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004574 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004575 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004576
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004577 if ((image_state->createInfo.imageType == VK_IMAGE_TYPE_1D) || (image_state->createInfo.imageType == VK_IMAGE_TYPE_2D)) {
4578 if ((pRegions[i].imageOffset.z != 0) || (pRegions[i].imageExtent.depth != 1)) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004579 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 -06004580 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-srcImage-00201",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004581 "%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 -06004582 "must be 0 and 1, respectively.",
4583 function, i, pRegions[i].imageOffset.z, pRegions[i].imageExtent.depth);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004584 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004585 }
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004586
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004587 if (image_state->createInfo.imageType == VK_IMAGE_TYPE_3D) {
4588 if ((0 != pRegions[i].imageSubresource.baseArrayLayer) || (1 != pRegions[i].imageSubresource.layerCount)) {
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004589 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004590 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-baseArrayLayer-00213",
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06004591 "%s(): pRegion[%d] imageSubresource.baseArrayLayer is %d and imageSubresource.layerCount is %d. "
4592 "For 3D images these must be 0 and 1, respectively.",
4593 function, i, pRegions[i].imageSubresource.baseArrayLayer, pRegions[i].imageSubresource.layerCount);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004594 }
4595 }
4596
4597 // If the the calling command's VkImage parameter's format is not a depth/stencil format,
Dave Houltona585d132019-01-18 13:05:42 -07004598 // then bufferOffset must be a multiple of the calling command's VkImage parameter's element size
4599 uint32_t element_size = FormatElementSize(image_state->createInfo.format);
4600 if (!FormatIsDepthAndStencil(image_state->createInfo.format) && SafeModulo(pRegions[i].bufferOffset, element_size) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004601 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 -06004602 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00193",
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004603 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004604 " must be a multiple of this format's texel size (%" PRIu32 ").",
4605 function, i, pRegions[i].bufferOffset, element_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004606 }
4607
4608 // BufferOffset must be a multiple of 4
Dave Houlton1d2022c2017-03-29 11:43:58 -06004609 if (SafeModulo(pRegions[i].bufferOffset, 4) != 0) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -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-bufferOffset-00194",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004612 "%s(): pRegion[%d] bufferOffset 0x%" PRIxLEAST64 " must be a multiple of 4.", function, i,
4613 pRegions[i].bufferOffset);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004614 }
4615
4616 // BufferRowLength must be 0, or greater than or equal to the width member of imageExtent
4617 if ((pRegions[i].bufferRowLength != 0) && (pRegions[i].bufferRowLength < pRegions[i].imageExtent.width)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004618 skip |=
4619 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004620 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferRowLength-00195",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004621 "%s(): pRegion[%d] bufferRowLength (%d) must be zero or greater-than-or-equal-to imageExtent.width (%d).",
4622 function, i, pRegions[i].bufferRowLength, pRegions[i].imageExtent.width);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004623 }
4624
4625 // BufferImageHeight must be 0, or greater than or equal to the height member of imageExtent
4626 if ((pRegions[i].bufferImageHeight != 0) && (pRegions[i].bufferImageHeight < pRegions[i].imageExtent.height)) {
4627 skip |= log_msg(
4628 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004629 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00196",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004630 "%s(): pRegion[%d] bufferImageHeight (%d) must be zero or greater-than-or-equal-to imageExtent.height (%d).",
4631 function, i, pRegions[i].bufferImageHeight, pRegions[i].imageExtent.height);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004632 }
4633
4634 // subresource aspectMask must have exactly 1 bit set
4635 const int num_bits = sizeof(VkFlags) * CHAR_BIT;
4636 std::bitset<num_bits> aspect_mask_bits(pRegions[i].imageSubresource.aspectMask);
4637 if (aspect_mask_bits.count() != 1) {
4638 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 -06004639 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00212",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004640 "%s: aspectMasks for imageSubresource in each region must have only a single bit set.", function);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004641 }
4642
4643 // image subresource aspect bit must match format
Dave Houlton4eaaf3a2017-03-14 11:31:20 -06004644 if (!VerifyAspectsPresent(pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004645 skip |= log_msg(
4646 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004647 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-aspectMask-00211",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004648 "%s(): pRegion[%d] subresource aspectMask 0x%x specifies aspects that are not present in image format 0x%x.",
4649 function, i, pRegions[i].imageSubresource.aspectMask, image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004650 }
4651
4652 // Checks that apply only to compressed images
Cort Stratton420ebd42018-05-04 01:12:23 -04004653 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004654 auto block_size = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004655
4656 // BufferRowLength must be a multiple of block width
Dave Houlton1d2022c2017-03-29 11:43:58 -06004657 if (SafeModulo(pRegions[i].bufferRowLength, block_size.width) != 0) {
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004658 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-bufferRowLength-00203",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004661 "%s(): pRegion[%d] bufferRowLength (%d) must be a multiple of the compressed image's texel width (%d)..",
4662 function, i, pRegions[i].bufferRowLength, block_size.width);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004663 }
4664
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004665 // BufferRowHeight must be a multiple of block height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004666 if (SafeModulo(pRegions[i].bufferImageHeight, block_size.height) != 0) {
Dave Houltona9df0ce2018-02-07 10:51:23 -07004667 skip |= log_msg(
4668 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004669 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferImageHeight-00204",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004670 "%s(): pRegion[%d] bufferImageHeight (%d) must be a multiple of the compressed image's texel height (%d)..",
4671 function, i, pRegions[i].bufferImageHeight, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004672 }
4673
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004674 // image offsets must be multiples of block dimensions
Dave Houlton1d2022c2017-03-29 11:43:58 -06004675 if ((SafeModulo(pRegions[i].imageOffset.x, block_size.width) != 0) ||
4676 (SafeModulo(pRegions[i].imageOffset.y, block_size.height) != 0) ||
4677 (SafeModulo(pRegions[i].imageOffset.z, block_size.depth) != 0)) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004678 skip |=
4679 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT,
Dave Houltond8ed0212018-05-16 17:18:24 -06004680 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageOffset-00205",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004681 "%s(): pRegion[%d] imageOffset(x,y) (%d, %d) must be multiples of the compressed image's texel "
4682 "width & height (%d, %d)..",
4683 function, i, pRegions[i].imageOffset.x, pRegions[i].imageOffset.y, block_size.width, block_size.height);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004684 }
4685
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004686 // bufferOffset must be a multiple of block size (linear bytes)
Dave Houltona585d132019-01-18 13:05:42 -07004687 uint32_t block_size_in_bytes = FormatElementSize(image_state->createInfo.format);
Dave Houlton1d2022c2017-03-29 11:43:58 -06004688 if (SafeModulo(pRegions[i].bufferOffset, block_size_in_bytes) != 0) {
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004689 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 -06004690 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-bufferOffset-00206",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004691 "%s(): pRegion[%d] bufferOffset (0x%" PRIxLEAST64
Dave Houltona585d132019-01-18 13:05:42 -07004692 ") must be a multiple of the compressed image's texel block size (%" PRIu32 ")..",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004693 function, i, pRegions[i].bufferOffset, block_size_in_bytes);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004694 }
Dave Houlton67e9b532017-03-02 17:00:10 -07004695
4696 // imageExtent width must be a multiple of block width, or extent+offset width must equal subresource width
Dave Houlton75967fc2017-03-06 17:21:16 -07004697 VkExtent3D mip_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
Dave Houlton1d2022c2017-03-29 11:43:58 -06004698 if ((SafeModulo(pRegions[i].imageExtent.width, block_size.width) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004699 (pRegions[i].imageExtent.width + pRegions[i].imageOffset.x != mip_extent.width)) {
4700 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 -06004701 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00207",
Dave Houlton75967fc2017-03-06 17:21:16 -07004702 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block width "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004703 "(%d), or when added to offset.x (%d) must equal the image subresource width (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004704 function, i, pRegions[i].imageExtent.width, block_size.width, pRegions[i].imageOffset.x,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004705 mip_extent.width);
Dave Houlton67e9b532017-03-02 17:00:10 -07004706 }
4707
4708 // imageExtent height must be a multiple of block height, or extent+offset height must equal subresource height
Dave Houlton1d2022c2017-03-29 11:43:58 -06004709 if ((SafeModulo(pRegions[i].imageExtent.height, block_size.height) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004710 (pRegions[i].imageExtent.height + pRegions[i].imageOffset.y != mip_extent.height)) {
4711 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 -06004712 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00208",
Dave Houlton75967fc2017-03-06 17:21:16 -07004713 "%s(): pRegion[%d] extent height (%d) must be a multiple of the compressed texture block height "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004714 "(%d), or when added to offset.y (%d) must equal the image subresource height (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004715 function, i, pRegions[i].imageExtent.height, block_size.height, pRegions[i].imageOffset.y,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004716 mip_extent.height);
Dave Houlton67e9b532017-03-02 17:00:10 -07004717 }
4718
4719 // imageExtent depth must be a multiple of block depth, or extent+offset depth must equal subresource depth
Dave Houlton1d2022c2017-03-29 11:43:58 -06004720 if ((SafeModulo(pRegions[i].imageExtent.depth, block_size.depth) != 0) &&
Dave Houlton75967fc2017-03-06 17:21:16 -07004721 (pRegions[i].imageExtent.depth + pRegions[i].imageOffset.z != mip_extent.depth)) {
4722 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 -06004723 HandleToUint64(image_state->image), "VUID-VkBufferImageCopy-imageExtent-00209",
Dave Houlton75967fc2017-03-06 17:21:16 -07004724 "%s(): pRegion[%d] extent width (%d) must be a multiple of the compressed texture block depth "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004725 "(%d), or when added to offset.z (%d) must equal the image subresource depth (%d)..",
Dave Houlton75967fc2017-03-06 17:21:16 -07004726 function, i, pRegions[i].imageExtent.depth, block_size.depth, pRegions[i].imageOffset.z,
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004727 mip_extent.depth);
Dave Houlton67e9b532017-03-02 17:00:10 -07004728 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004729 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004730 }
4731
4732 return skip;
4733}
4734
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004735static bool ValidateImageBounds(const debug_report_data *report_data, const IMAGE_STATE *image_state, const uint32_t regionCount,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004736 const VkBufferImageCopy *pRegions, const char *func_name, const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004737 bool skip = false;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004738 const VkImageCreateInfo *image_info = &(image_state->createInfo);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004739
4740 for (uint32_t i = 0; i < regionCount; i++) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004741 VkExtent3D extent = pRegions[i].imageExtent;
4742 VkOffset3D offset = pRegions[i].imageOffset;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004743
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004744 if (IsExtentSizeZero(&extent)) // Warn on zero area subresource
4745 {
Dave Houlton51653902018-06-22 17:32:13 -06004746 skip |=
4747 log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4748 kVUID_Core_Image_ZeroAreaSubregion, "%s: pRegion[%d] imageExtent of {%1d, %1d, %1d} has zero area",
4749 func_name, i, extent.width, extent.height, extent.depth);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004750 }
4751
4752 VkExtent3D image_extent = GetImageSubresourceExtent(image_state, &(pRegions[i].imageSubresource));
4753
4754 // 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 -06004755 if (FormatIsCompressed(image_info->format)) {
Dave Houltona585d132019-01-18 13:05:42 -07004756 auto block_extent = FormatTexelBlockExtent(image_info->format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004757 if (image_extent.width % block_extent.width) {
4758 image_extent.width += (block_extent.width - (image_extent.width % block_extent.width));
4759 }
4760 if (image_extent.height % block_extent.height) {
4761 image_extent.height += (block_extent.height - (image_extent.height % block_extent.height));
4762 }
4763 if (image_extent.depth % block_extent.depth) {
4764 image_extent.depth += (block_extent.depth - (image_extent.depth % block_extent.depth));
4765 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004766 }
4767
Dave Houltonfc1a4052017-04-27 14:32:45 -06004768 if (0 != ExceedsBounds(&offset, &extent, &image_extent)) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004769 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 -06004770 msg_code, "%s: pRegion[%d] exceeds image bounds..", func_name, i);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004771 }
4772 }
4773
4774 return skip;
4775}
4776
Chris Forbese8ba09a2017-06-01 17:39:02 -07004777static inline bool ValidateBufferBounds(const debug_report_data *report_data, IMAGE_STATE *image_state, BUFFER_STATE *buff_state,
Dave Houlton33c2d252017-06-09 17:08:32 -06004778 uint32_t regionCount, const VkBufferImageCopy *pRegions, const char *func_name,
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06004779 const char *msg_code) {
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004780 bool skip = false;
4781
4782 VkDeviceSize buffer_size = buff_state->createInfo.size;
4783
4784 for (uint32_t i = 0; i < regionCount; i++) {
4785 VkExtent3D copy_extent = pRegions[i].imageExtent;
4786
4787 VkDeviceSize buffer_width = (0 == pRegions[i].bufferRowLength ? copy_extent.width : pRegions[i].bufferRowLength);
4788 VkDeviceSize buffer_height = (0 == pRegions[i].bufferImageHeight ? copy_extent.height : pRegions[i].bufferImageHeight);
Dave Houltona585d132019-01-18 13:05:42 -07004789 VkDeviceSize unit_size = FormatElementSize(image_state->createInfo.format); // size (bytes) of texel or block
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004790
Dave Houltonf3229d52017-02-21 15:59:08 -07004791 // Handle special buffer packing rules for specific depth/stencil formats
4792 if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
Dave Houltona585d132019-01-18 13:05:42 -07004793 unit_size = FormatElementSize(VK_FORMAT_S8_UINT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004794 } else if (pRegions[i].imageSubresource.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
4795 switch (image_state->createInfo.format) {
4796 case VK_FORMAT_D16_UNORM_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004797 unit_size = FormatElementSize(VK_FORMAT_D16_UNORM);
Dave Houltonf3229d52017-02-21 15:59:08 -07004798 break;
4799 case VK_FORMAT_D32_SFLOAT_S8_UINT:
Dave Houltona585d132019-01-18 13:05:42 -07004800 unit_size = FormatElementSize(VK_FORMAT_D32_SFLOAT);
Dave Houltonf3229d52017-02-21 15:59:08 -07004801 break;
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004802 case VK_FORMAT_X8_D24_UNORM_PACK32: // Fall through
Dave Houltonf3229d52017-02-21 15:59:08 -07004803 case VK_FORMAT_D24_UNORM_S8_UINT:
4804 unit_size = 4;
4805 break;
4806 default:
4807 break;
4808 }
4809 }
4810
Tom Cooperb2550c72018-10-15 13:08:41 +01004811 if (FormatIsCompressed(image_state->createInfo.format) || FormatIsSinglePlane_422(image_state->createInfo.format)) {
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004812 // Switch to texel block units, rounding up for any partially-used blocks
Dave Houltona585d132019-01-18 13:05:42 -07004813 auto block_dim = FormatTexelBlockExtent(image_state->createInfo.format);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004814 buffer_width = (buffer_width + block_dim.width - 1) / block_dim.width;
4815 buffer_height = (buffer_height + block_dim.height - 1) / block_dim.height;
4816
4817 copy_extent.width = (copy_extent.width + block_dim.width - 1) / block_dim.width;
4818 copy_extent.height = (copy_extent.height + block_dim.height - 1) / block_dim.height;
4819 copy_extent.depth = (copy_extent.depth + block_dim.depth - 1) / block_dim.depth;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004820 }
4821
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004822 // Either depth or layerCount may be greater than 1 (not both). This is the number of 'slices' to copy
4823 uint32_t z_copies = std::max(copy_extent.depth, pRegions[i].imageSubresource.layerCount);
4824 if (IsExtentSizeZero(&copy_extent) || (0 == z_copies)) {
Chris Forbese8ba09a2017-06-01 17:39:02 -07004825 // TODO: Issue warning here? Already warned in ValidateImageBounds()...
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004826 } else {
4827 // Calculate buffer offset of final copied byte, + 1.
4828 VkDeviceSize max_buffer_offset = (z_copies - 1) * buffer_height * buffer_width; // offset to slice
4829 max_buffer_offset += ((copy_extent.height - 1) * buffer_width) + copy_extent.width; // add row,col
4830 max_buffer_offset *= unit_size; // convert to bytes
4831 max_buffer_offset += pRegions[i].bufferOffset; // add initial offset (bytes)
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004832
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004833 if (buffer_size < max_buffer_offset) {
Mark Lobodzinski88529492018-04-01 10:38:15 -06004834 skip |=
4835 log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_COMMAND_BUFFER_EXT, (uint64_t)0,
4836 msg_code, "%s: pRegion[%d] exceeds buffer size of %" PRIu64 " bytes..", func_name, i, buffer_size);
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004837 }
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004838 }
4839 }
4840
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07004841 return skip;
4842}
4843
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004844bool CoreChecks::PreCallValidateCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4845 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004846 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004847 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004848 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004849 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004850
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004851 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, src_image_state, "vkCmdCopyImageToBuffer");
4852
4853 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004854 skip |= ValidateCmd(device_data, cb_node, CMD_COPYIMAGETOBUFFER, "vkCmdCopyImageToBuffer()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004855
4856 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004857 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004858
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004859 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskif6dd3762019-02-27 12:11:59 -07004860
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004861 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4862 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 -06004863 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyImageToBuffer-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004864 "Cannot call vkCmdCopyImageToBuffer() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004865 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004866 }
Dave Houlton0ef27492018-04-04 11:41:48 -06004867 skip |= ValidateImageBounds(report_data, src_image_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004868 "VUID-vkCmdCopyImageToBuffer-pRegions-00182");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004869 skip |= ValidateBufferBounds(report_data, src_image_state, dst_buffer_state, regionCount, pRegions, "vkCmdCopyImageToBuffer()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004870 "VUID-vkCmdCopyImageToBuffer-pRegions-00183");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004871
4872 skip |= ValidateImageSampleCount(device_data, src_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyImageToBuffer(): srcImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004873 "VUID-vkCmdCopyImageToBuffer-srcImage-00188");
4874 skip |= ValidateMemoryIsBoundToImage(device_data, src_image_state, "vkCmdCopyImageToBuffer()",
4875 "VUID-vkCmdCopyImageToBuffer-srcImage-00187");
4876 skip |= ValidateMemoryIsBoundToBuffer(device_data, dst_buffer_state, "vkCmdCopyImageToBuffer()",
4877 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00192");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004878
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004879 // Validate that SRC image & DST buffer have correct usage flags set
Dave Houltond8ed0212018-05-16 17:18:24 -06004880 skip |= ValidateImageUsageFlags(device_data, src_image_state, VK_IMAGE_USAGE_TRANSFER_SRC_BIT, true,
4881 "VUID-vkCmdCopyImageToBuffer-srcImage-00186", "vkCmdCopyImageToBuffer()",
4882 "VK_IMAGE_USAGE_TRANSFER_SRC_BIT");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004883 skip |= ValidateBufferUsageFlags(device_data, dst_buffer_state, VK_BUFFER_USAGE_TRANSFER_DST_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004884 "VUID-vkCmdCopyImageToBuffer-dstBuffer-00191", "vkCmdCopyImageToBuffer()",
4885 "VK_BUFFER_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004886 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004887 skip |= ValidateImageFormatFeatureFlags(device_data, src_image_state, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004888 "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-srcImage-01998",
4889 "VUID-vkCmdCopyImageToBuffer-srcImage-01998");
Cort Stratton186b1a22018-05-01 20:18:06 -04004890 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004891 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyImageToBuffer()", "VUID-vkCmdCopyImageToBuffer-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004892 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004893 const char *src_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004894 (src_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004895 ? "VUID-vkCmdCopyImageToBuffer-srcImageLayout-01397"
4896 : "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00190";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004897 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004898 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyImageToBuffer()",
4899 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004900 skip |= VerifyImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004901 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, "vkCmdCopyImageToBuffer()", src_invalid_layout_vuid,
4902 "VUID-vkCmdCopyImageToBuffer-srcImageLayout-00189", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004903 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, src_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004904 "vkCmdCopyImageToBuffer()",
4905 "VUID-vkCmdCopyImageToBuffer-imageOffset-01794");
Cort Strattonff1542a2018-05-27 10:49:28 -07004906 skip |= ValidateImageMipLevel(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.mipLevel, i,
4907 "vkCmdCopyImageToBuffer()", "imageSubresource",
4908 "VUID-vkCmdCopyImageToBuffer-imageSubresource-01703");
4909 skip |= ValidateImageArrayLayerRange(device_data, cb_node, src_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4910 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyImageToBuffer()",
4911 "imageSubresource", "VUID-vkCmdCopyImageToBuffer-imageSubresource-01704");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004912 }
4913 return skip;
4914}
4915
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004916void CoreChecks::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4917 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004918 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004919 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004920 auto src_image_state = GetImageState(srcImage);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004921 auto dst_buffer_state = GetBufferState(dstBuffer);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004922
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004923 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004924 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004925 SetImageLayout(cb_node, src_image_state, pRegions[i].imageSubresource, srcImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06004926 }
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004927 // Update bindings between buffer/image and cmd buffer
4928 AddCommandBufferBindingImage(device_data, cb_node, src_image_state);
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07004929 AddCommandBufferBindingBuffer(device_data, cb_node, dst_buffer_state);
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004930}
4931
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004932bool CoreChecks::PreCallValidateCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4933 VkImageLayout dstImageLayout, uint32_t regionCount,
4934 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004935 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07004936 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07004937 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07004938 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07004939
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004940 bool skip = ValidateBufferImageCopyData(report_data, regionCount, pRegions, dst_image_state, "vkCmdCopyBufferToImage");
4941
4942 // Validate command buffer state
John Zulauf5c2750c2018-01-30 15:04:56 -07004943 skip |= ValidateCmd(device_data, cb_node, CMD_COPYBUFFERTOIMAGE, "vkCmdCopyBufferToImage()");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004944
4945 // Command pool must support graphics, compute, or transfer operations
Mark Lobodzinski8b0a7b82019-03-06 16:17:45 -07004946 auto pPool = GetCommandPoolNode(cb_node->createInfo.commandPool);
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07004947 VkQueueFlags queue_flags = GetPhysicalDeviceState()->queue_family_properties[pPool->queueFamilyIndex].queueFlags;
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004948 if (0 == (queue_flags & (VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT))) {
4949 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 -06004950 HandleToUint64(cb_node->createInfo.commandPool), "VUID-vkCmdCopyBufferToImage-commandBuffer-cmdpool",
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004951 "Cannot call vkCmdCopyBufferToImage() on a command buffer allocated from a pool without graphics, compute, "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06004952 "or transfer capabilities..");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004953 }
Dave Houlton9dae7ec2017-03-01 16:23:25 -07004954 skip |= ValidateImageBounds(report_data, dst_image_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004955 "VUID-vkCmdCopyBufferToImage-pRegions-00172");
Chris Forbese8ba09a2017-06-01 17:39:02 -07004956 skip |= ValidateBufferBounds(report_data, dst_image_state, src_buffer_state, regionCount, pRegions, "vkCmdCopyBufferToImage()",
Dave Houltond8ed0212018-05-16 17:18:24 -06004957 "VUID-vkCmdCopyBufferToImage-pRegions-00171");
Mark Lobodzinskid2b2f612017-02-15 13:45:18 -07004958 skip |= ValidateImageSampleCount(device_data, dst_image_state, VK_SAMPLE_COUNT_1_BIT, "vkCmdCopyBufferToImage(): dstImage",
Dave Houltond8ed0212018-05-16 17:18:24 -06004959 "VUID-vkCmdCopyBufferToImage-dstImage-00179");
4960 skip |= ValidateMemoryIsBoundToBuffer(device_data, src_buffer_state, "vkCmdCopyBufferToImage()",
4961 "VUID-vkCmdCopyBufferToImage-srcBuffer-00176");
4962 skip |= ValidateMemoryIsBoundToImage(device_data, dst_image_state, "vkCmdCopyBufferToImage()",
4963 "VUID-vkCmdCopyBufferToImage-dstImage-00178");
Tobin Ehlis3c37fb32017-05-24 09:31:13 -06004964 skip |= ValidateBufferUsageFlags(device_data, src_buffer_state, VK_BUFFER_USAGE_TRANSFER_SRC_BIT, true,
Dave Houltond8ed0212018-05-16 17:18:24 -06004965 "VUID-vkCmdCopyBufferToImage-srcBuffer-00174", "vkCmdCopyBufferToImage()",
4966 "VK_BUFFER_USAGE_TRANSFER_SRC_BIT");
4967 skip |= ValidateImageUsageFlags(device_data, dst_image_state, VK_IMAGE_USAGE_TRANSFER_DST_BIT, true,
4968 "VUID-vkCmdCopyBufferToImage-dstImage-00177", "vkCmdCopyBufferToImage()",
4969 "VK_IMAGE_USAGE_TRANSFER_DST_BIT");
Mark Lobodzinski96d5c6e2019-03-07 11:28:21 -07004970 if (GetApiVersion() >= VK_API_VERSION_1_1 || GetDeviceExtensions()->vk_khr_maintenance1) {
Cort Stratton186b1a22018-05-01 20:18:06 -04004971 skip |= ValidateImageFormatFeatureFlags(device_data, dst_image_state, VK_FORMAT_FEATURE_TRANSFER_DST_BIT,
Shannon McPherson40c0cba2018-08-07 13:39:13 -06004972 "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-dstImage-01997",
4973 "VUID-vkCmdCopyBufferToImage-dstImage-01997");
Cort Stratton186b1a22018-05-01 20:18:06 -04004974 }
Shannon McPhersonc06c33d2018-06-28 17:21:12 -06004975 skip |= InsideRenderPass(device_data, cb_node, "vkCmdCopyBufferToImage()", "VUID-vkCmdCopyBufferToImage-renderpass");
Tobin Ehlisc8266452017-04-07 12:20:30 -06004976 bool hit_error = false;
Jeff Bolzfdd0d852019-02-03 21:55:12 -06004977 const char *dst_invalid_layout_vuid =
Mark Lobodzinski60e79032019-03-07 10:22:31 -07004978 (dst_image_state->shared_presentable && GetDeviceExtensions()->vk_khr_shared_presentable_image)
Cort Stratton7df30962018-05-17 19:45:57 -07004979 ? "VUID-vkCmdCopyBufferToImage-dstImageLayout-01396"
4980 : "VUID-vkCmdCopyBufferToImage-dstImageLayout-00181";
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004981 for (uint32_t i = 0; i < regionCount; ++i) {
Cort Strattond619a302018-05-17 19:46:32 -07004982 skip |= ValidateImageSubresourceLayers(device_data, cb_node, &pRegions[i].imageSubresource, "vkCmdCopyBufferToImage()",
4983 "imageSubresource", i);
Mark Lobodzinski8564e442019-03-07 12:49:41 -07004984 skip |= VerifyImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout,
Cort Stratton7df30962018-05-17 19:45:57 -07004985 VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, "vkCmdCopyBufferToImage()", dst_invalid_layout_vuid,
4986 "VUID-vkCmdCopyBufferToImage-dstImageLayout-00180", &hit_error);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004987 skip |= ValidateCopyBufferImageTransferGranularityRequirements(device_data, cb_node, dst_image_state, &pRegions[i], i,
Dave Houltond8ed0212018-05-16 17:18:24 -06004988 "vkCmdCopyBufferToImage()",
4989 "VUID-vkCmdCopyBufferToImage-imageOffset-01793");
Cort Strattonff1542a2018-05-27 10:49:28 -07004990 skip |= ValidateImageMipLevel(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.mipLevel, i,
4991 "vkCmdCopyBufferToImage()", "imageSubresource",
4992 "VUID-vkCmdCopyBufferToImage-imageSubresource-01701");
4993 skip |= ValidateImageArrayLayerRange(device_data, cb_node, dst_image_state, pRegions[i].imageSubresource.baseArrayLayer,
4994 pRegions[i].imageSubresource.layerCount, i, "vkCmdCopyBufferToImage()",
4995 "imageSubresource", "VUID-vkCmdCopyBufferToImage-imageSubresource-01702");
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07004996 }
4997 return skip;
4998}
4999
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005000void CoreChecks::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
5001 VkImageLayout dstImageLayout, uint32_t regionCount,
5002 const VkBufferImageCopy *pRegions) {
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005003 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(commandBuffer), layer_data_map);
Mark Lobodzinski1b3a9712019-03-06 15:51:47 -07005004 auto cb_node = GetCBNode(commandBuffer);
Mark Lobodzinski6ed74142019-03-06 11:35:39 -07005005 auto src_buffer_state = GetBufferState(srcBuffer);
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005006 auto dst_image_state = GetImageState(dstImage);
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005007
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005008 // Make sure that all image slices are updated to correct layout
Mark Lobodzinskib7eafbe2019-01-10 13:40:39 -07005009 for (uint32_t i = 0; i < regionCount; ++i) {
Mark Lobodzinski8564e442019-03-07 12:49:41 -07005010 SetImageLayout(cb_node, dst_image_state, pRegions[i].imageSubresource, dstImageLayout);
Tobin Ehlise35b66a2017-03-15 12:18:31 -06005011 }
Mark Lobodzinski1fe9b002017-02-15 14:11:12 -07005012 AddCommandBufferBindingBuffer(device_data, cb_node, src_buffer_state);
Mark Lobodzinski033c90b2017-02-15 13:58:23 -07005013 AddCommandBufferBindingImage(device_data, cb_node, dst_image_state);
Mark Lobodzinskiab9ea3e2017-02-15 12:59:00 -07005014}
Mike Weiblen672b58b2017-02-21 14:32:53 -07005015
Mark Lobodzinskib56bbb92019-02-18 11:49:59 -07005016bool CoreChecks::PreCallValidateGetImageSubresourceLayout(VkDevice device, VkImage image, const VkImageSubresource *pSubresource,
5017 VkSubresourceLayout *pLayout) {
Mark Lobodzinski6b35c8a2019-01-10 10:57:27 -07005018 layer_data *device_data = GetLayerDataPtr(get_dispatch_key(device), layer_data_map);
5019 const auto report_data = device_data->report_data;
Mike Weiblen672b58b2017-02-21 14:32:53 -07005020 bool skip = false;
5021 const VkImageAspectFlags sub_aspect = pSubresource->aspectMask;
5022
Dave Houlton1d960ff2018-01-19 12:17:05 -07005023 // The aspectMask member of pSubresource must only have a single bit set
Mike Weiblen672b58b2017-02-21 14:32:53 -07005024 const int num_bits = sizeof(sub_aspect) * CHAR_BIT;
5025 std::bitset<num_bits> aspect_mask_bits(sub_aspect);
5026 if (aspect_mask_bits.count() != 1) {
Petr Krausbc7f5442017-05-14 23:43:38 +02005027 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 -06005028 "VUID-vkGetImageSubresourceLayout-aspectMask-00997",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005029 "vkGetImageSubresourceLayout(): VkImageSubresource.aspectMask must have exactly 1 bit set.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005030 }
5031
Mark Lobodzinski8ddc23f2019-03-06 11:48:49 -07005032 IMAGE_STATE *image_entry = GetImageState(image);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005033 if (!image_entry) {
5034 return skip;
5035 }
5036
Dave Houlton1d960ff2018-01-19 12:17:05 -07005037 // image must have been created with tiling equal to VK_IMAGE_TILING_LINEAR
Mike Weiblen672b58b2017-02-21 14:32:53 -07005038 if (image_entry->createInfo.tiling != VK_IMAGE_TILING_LINEAR) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005039 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5040 "VUID-vkGetImageSubresourceLayout-image-00996",
5041 "vkGetImageSubresourceLayout(): Image must have tiling of VK_IMAGE_TILING_LINEAR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005042 }
5043
Dave Houlton1d960ff2018-01-19 12:17:05 -07005044 // mipLevel must be less than the mipLevels specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005045 if (pSubresource->mipLevel >= image_entry->createInfo.mipLevels) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005046 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5047 "VUID-vkGetImageSubresourceLayout-mipLevel-01716",
5048 "vkGetImageSubresourceLayout(): pSubresource.mipLevel (%d) must be less than %d.", pSubresource->mipLevel,
5049 image_entry->createInfo.mipLevels);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005050 }
5051
Dave Houlton1d960ff2018-01-19 12:17:05 -07005052 // arrayLayer must be less than the arrayLayers specified in VkImageCreateInfo when the image was created
Mike Weiblen672b58b2017-02-21 14:32:53 -07005053 if (pSubresource->arrayLayer >= image_entry->createInfo.arrayLayers) {
Dave Houltond8ed0212018-05-16 17:18:24 -06005054 skip |= log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
5055 "VUID-vkGetImageSubresourceLayout-arrayLayer-01717",
5056 "vkGetImageSubresourceLayout(): pSubresource.arrayLayer (%d) must be less than %d.",
5057 pSubresource->arrayLayer, image_entry->createInfo.arrayLayers);
Mike Weiblen672b58b2017-02-21 14:32:53 -07005058 }
5059
Dave Houlton1d960ff2018-01-19 12:17:05 -07005060 // subresource's aspect must be compatible with image's format.
Mike Weiblen672b58b2017-02-21 14:32:53 -07005061 const VkFormat img_format = image_entry->createInfo.format;
Dave Houlton1d960ff2018-01-19 12:17:05 -07005062 if (FormatIsMultiplane(img_format)) {
5063 VkImageAspectFlags allowed_flags = (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR | VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
Jeff Bolz6d3beaa2019-02-09 21:00:05 -06005064 const char *vuid = "VUID-vkGetImageSubresourceLayout-format-01581"; // 2-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005065 if (FormatPlaneCount(img_format) > 2u) {
5066 allowed_flags |= VK_IMAGE_ASPECT_PLANE_2_BIT_KHR;
Dave Houltond8ed0212018-05-16 17:18:24 -06005067 vuid = "VUID-vkGetImageSubresourceLayout-format-01582"; // 3-plane version
Dave Houlton1d960ff2018-01-19 12:17:05 -07005068 }
5069 if (sub_aspect != (sub_aspect & allowed_flags)) {
5070 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 -06005071 HandleToUint64(image), vuid,
Dave Houlton1d960ff2018-01-19 12:17:05 -07005072 "vkGetImageSubresourceLayout(): For multi-planar images, VkImageSubresource.aspectMask (0x%" PRIx32
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005073 ") must be a single-plane specifier flag.",
5074 sub_aspect);
Dave Houlton1d960ff2018-01-19 12:17:05 -07005075 }
5076 } else if (FormatIsColor(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005077 if (sub_aspect != VK_IMAGE_ASPECT_COLOR_BIT) {
Dave Houlton852287e2018-01-19 15:11:51 -07005078 skip |= log_msg(
Mark Lobodzinskib1fd9d12018-03-30 14:26:00 -06005079 report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT, HandleToUint64(image),
Dave Houltond8ed0212018-05-16 17:18:24 -06005080 "VUID-VkImageSubresource-aspectMask-parameter",
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005081 "vkGetImageSubresourceLayout(): For color formats, VkImageSubresource.aspectMask must be VK_IMAGE_ASPECT_COLOR.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005082 }
Dave Houlton1d2022c2017-03-29 11:43:58 -06005083 } else if (FormatIsDepthOrStencil(img_format)) {
Mike Weiblen672b58b2017-02-21 14:32:53 -07005084 if ((sub_aspect != VK_IMAGE_ASPECT_DEPTH_BIT) && (sub_aspect != VK_IMAGE_ASPECT_STENCIL_BIT)) {
Mark Lobodzinski0827aec2017-03-21 16:41:45 -06005085 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 -06005086 HandleToUint64(image), "VUID-VkImageSubresource-aspectMask-parameter",
Mike Weiblen672b58b2017-02-21 14:32:53 -07005087 "vkGetImageSubresourceLayout(): For depth/stencil formats, VkImageSubresource.aspectMask must be "
Mark Lobodzinski487a0d12018-03-30 10:09:03 -06005088 "either VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT.");
Mike Weiblen672b58b2017-02-21 14:32:53 -07005089 }
5090 }
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005091
Mark Lobodzinski60e79032019-03-07 10:22:31 -07005092 if (GetDeviceExtensions()->vk_android_external_memory_android_hardware_buffer) {
Dave Houlton0d4ad6f2018-09-05 14:53:34 -06005093 skip |= ValidateGetImageSubresourceLayoutANDROID(device_data, image);
5094 }
5095
Mike Weiblen672b58b2017-02-21 14:32:53 -07005096 return skip;
5097}